dg::geo::solovev::Parameters Struct Reference

Constructs and display geometric parameters for the solovev and taylor fields. More...

Public Member Functions
	Parameters ()=default
	Parameters (const dg::file::WrappedJsonValue &js)
	Construct from Json dataset.
dg::file::JsonType	dump () const
	Put values into a json string.
bool	hasXpoint () const
	True if any coefficient c_i!=0 with 7<=i<12.
bool	isToroidal () const
	True if pp==0.
void	display (std::ostream &os=std::cout) const
	Write variables as a formatted string.

Public Attributes
double	A
	A coefficient.
double	R_0
	major tokamak radius
double	pp
	prefactor for Psi_p
double	pi
	prefactor for current I
double	a
	little tokamak radius
double	elongation
	elongation of the magnetic surfaces
double	triangularity
	triangularity of the magnetic surfaces
std::vector< double >	c
	12 coefficients for the solovev equilibrium;
std::string	description

Detailed Description

Constructs and display geometric parameters for the solovev and taylor fields.

Constructor & Destructor Documentation

Parameters() [1/2]

dg::geo::solovev::Parameters::Parameters ( )

default

Parameters() [2/2]

dg::geo::solovev::Parameters::Parameters ( const dg::file::WrappedJsonValue & js )

inline

Construct from Json dataset.

// Solovev (and Taylor) geometry parameters
{
    "equilibrium": "solovev",
    // "equilibrium" : "taylor",
    "A": 0,
    "R_0": 213.36,
    "PP": 1,
    "PI": 1,
    "c":[
        0.072597888572520090,
        -0.14926096478076946,
        // ... 12 coefficients in total
    ],
    "description" : "standardX",
    "inverseaspectratio": 0.3211009174311926,
    "triangularity": 0.3,
    "elongation": 1.44
}

See also

dg::geo::description to see valid values for the description field

Note

the dg::geo::taylor field is chosen by setting "taylor" in the equilibrium field

Parameters

js	valid Json object (see code above to see the valid key : value pairs)

Note

the default values in brackets are taken if the variables are not found in the input file

Member Function Documentation

display()

void dg::geo::solovev::Parameters::display ( std::ostream & os = std::cout ) const

inline

Write variables as a formatted string.

dump()

dg::file::JsonType dg::geo::solovev::Parameters::dump ( ) const

inline

Put values into a json string.

Returns

Json value

hasXpoint()

bool dg::geo::solovev::Parameters::hasXpoint ( ) const

inline

True if any coefficient c_i!=0 with 7<=i<12.

The Xpoint is situated close to R_X = R_0-1.1*triangularity*a Z_X = -1.1*elongation*a

Returns

true if Psip has an Xpoint, false else

isToroidal()

bool dg::geo::solovev::Parameters::isToroidal ( ) const

inline

True if pp==0.

Returns

true if the flux function is a constant

Member Data Documentation

A

double dg::geo::solovev::Parameters::A

A coefficient.

a

double dg::geo::solovev::Parameters::a

little tokamak radius

c

std::vector<double> dg::geo::solovev::Parameters::c

12 coefficients for the solovev equilibrium;

description

std::string dg::geo::solovev::Parameters::description

elongation

double dg::geo::solovev::Parameters::elongation

elongation of the magnetic surfaces

pi

double dg::geo::solovev::Parameters::pi

prefactor for current I

pp

double dg::geo::solovev::Parameters::pp

prefactor for Psi_p

R_0

double dg::geo::solovev::Parameters::R_0

major tokamak radius

triangularity

double dg::geo::solovev::Parameters::triangularity

triangularity of the magnetic surfaces

---

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

• solovev_parameters.h