dg::geo::mod::ClosedFieldlineRegion Struct Reference

Predicate identifying closed fieldline region. More...

Public Member Functions
	ClosedFieldlineRegion (const TokamakMagneticField &mag, bool closed=true)
	Construct from magnetic field.
bool	operator() (double R, double Z) const
	Return closed in closed fieldline region.

Detailed Description

Predicate identifying closed fieldline region.

Closed fieldlines are defined as

• without O-point there is no closed fieldline region
• with O-point anything is closed where Psip has same sign as O-point (0 is separatrix) otherwise not closed
• with X-point(s) the private flux regions are not closed

See also

dg::geo::SOLRegion

Note

Physically of course there are no "open" magnetic fieldlines that would contradict the vanishing divergence of the magnetic field. What "open" refers to is "intersects a material wall"

Constructor & Destructor Documentation

ClosedFieldlineRegion()

dg::geo::mod::ClosedFieldlineRegion::ClosedFieldlineRegion ( const TokamakMagneticField & mag, bool closed = true )

inline

Construct from magnetic field.

Parameters

mag	The magnetic field based on a flux function If no O-point exists no closed fieldline region exists
closed	if closed is false then the Functor acts as a OpenFieldLineRegion = not ClosedFieldlineRegion

Member Function Documentation

operator()()

bool dg::geo::mod::ClosedFieldlineRegion::operator() ( double R, double Z ) const

inline

Return closed in closed fieldline region.

Parameters

R	Cylindrical R coordinate
Z	Cylindrical Z coordinate

Returns

closed in closed fieldline region, else not closed

---

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

• modified.h