\( \psi_{mod} := \begin{cases} H(\psi_p(R,Z))\text{ for } P(R,Z) \\ \psi_p(R,Z) \text { else } \end{cases} \) More...

Inheritance diagram for dg::geo::mod::Psip:

Public Member Functions
	Psip (std::function< bool(double, double)> predicate, std::function< double(double, double)> psip, double psi0, double alpha, double sign=-1)

double	do_compute (double R, double Z) const

Public Member Functions inherited from dg::geo::aCylindricalFunctor< Psip >
double	operator() (double R, double Z) const
	`do_compute(R,Z)` More...

double	operator() (double R, double Z, double phi) const
	`do_compute(R,Z)` More...

Detailed Description

\( \psi_{mod} := \begin{cases} H(\psi_p(R,Z))\text{ for } P(R,Z) \\ \psi_p(R,Z) \text { else } \end{cases} \)

where H is the integrated dg::IPolynomialHeaviside function and P is a predicate that returns either true or false.

Note: the predicate can usually be true everywhere, the idea for the predicate is to be able to selectively target the private flux region(s) for modification.

Constructor & Destructor Documentation

dg::geo::mod::Psip::Psip	(	std::function< bool(double, double)>	predicate,
		std::function< double(double, double)>	psip,
		double	psi0,
		double	alpha,
		double	sign = `-1`
	)

inline

double dg::geo::mod::Psip::do_compute	(	double	R,
		double	Z
	)		const

inline

The documentation for this struct was generated from the following file: