#include <equil.hpp>

Collaboration diagram for Equilibrium:

Public Member Functions
	Equilibrium (NLReader::NamelistReader &nlr, const MagneticEquilFiles::Ptr &equil_files, const View< Equil::XPoint *, HostType > &xpts, const RZPair &axis_in)

	Equilibrium (PsiOption psi_opt)

	Equilibrium ()

KOKKOS_INLINE_FUNCTION bool	is_in_region_1_or_2 (double r, double z, double psi) const

KOKKOS_INLINE_FUNCTION bool	is_in_region_1 (double r, double z, double psi) const

KOKKOS_INLINE_FUNCTION bool	is_in_region_3b (double r, double z, double psi) const

KOKKOS_INLINE_FUNCTION int	node_region_3_index (double r, double z, double psi) const

KOKKOS_INLINE_FUNCTION bool	is_below_xpt_tangent (double r, double z) const

KOKKOS_INLINE_FUNCTION bool	is_above_xpt2_tangent (double r, double z) const

KOKKOS_INLINE_FUNCTION void	check_boundaries (const SimdVector2D &x, Simd< bool > &rz_outside) const

KOKKOS_INLINE_FUNCTION void	get_theta (const SimdVector2D &x, Simd< double > &theta) const

void	write (const DomainDecomposition< DeviceType > &pol_decomp, const View< double , CLayout, HostType > &eq_psi_grid, const View< double , CLayout, HostType > &eq_I, const View< double , CLayout, HostType > &eq_psi_rz, double bt_sign, double bp_sign, bool is_3D, int periodicity=1, int eq_mp=1, const View< double , CLayout, HostType > &eq_B_R_rz=View< double , CLayout, HostType >(NoInit("eq_B_R_rz"), 0, 0), const View< double , CLayout, HostType > &eq_B_Z_rz=View< double , CLayout, HostType >(NoInit("eq_B_Z_rz"), 0, 0), const View< double , CLayout, HostType > &eq_B_phi_rz=View< double , CLayout, HostType >(NoInit("eq_B_phi_rz"), 0, 0), const View< double , CLayout, HostType > &eq_VMEC_angle_rz=View< double , CLayout, HostType >(NoInit("eq_VMEC_angle_rz"), 0, 0), const View< double , CLayout, HostType > &eq_PEST_angle_rz=View< double **, CLayout, HostType >(NoInit("eq_PEST_angle_rz"), 0, 0))

void	set_decay_factors (double out_decay_factor_in, double priv_flux_decay_factor_in, double out_decay_width_in, double priv_flux_decay_width_in, bool set_xpt2_in)

Public Attributes
RZBounds	bounds
	Min and max for r and z. More...

double	xpt_psi
	Psi coordinate of 1st X-point. More...

double	psi_norm
	Psi value to use for normalization. More...

RZPair	xpt
	coordinates of 1st X-point More...

double	xpt_slope
	Slope (which slope?) at 1st X-point. More...

bool	set_xpt2
	Whether to use a 2nd X-point. More...

RZPair	xpt2
	coordinates of 2nd X-point More...

double	xpt2_slope
	Slope (which slope?) at 2nd X-point. More...

double	xpt2_psi
	psi coordinate at 2nd X-point More...

RZPair	axis
	coordinates of axis More...

double	axis_b
	magnetic field magnitude on axis More...

double	out_decay_factor
	profiles decay exponentially to f(sml_outpsi)/decay_factor for psi>sml_outpsi More...

double	priv_flux_decay_factor
	profiles decay exponentially to f(sml_outpsi)/decay_factor in priv. flux region More...

double	out_decay_width
	width for exponential decay for psi>sml_outpsi More...

double	priv_flux_decay_width
	width for exponential decay in private flux region More...

Static Public Attributes
static constexpr double	epsil_psi = 1.0e-05
	Not sure? More...

Constructor & Destructor Documentation

◆ Equilibrium() [1/3]

Equilibrium::Equilibrium	(	NLReader::NamelistReader &	nlr,
		const MagneticEquilFiles::Ptr &	equil_files_ptr,
		const View< Equil::XPoint *, HostType > &	xpts_in,
		const RZPair &	axis_in
	)

Constructor for equilibrium class

Here is the call graph for this function:

◆ Equilibrium() [2/3]

Equilibrium::Equilibrium ( PsiOption psi_opt )

inline

◆ Equilibrium() [3/3]

Equilibrium::Equilibrium ( )

inline

Member Function Documentation

◆ check_boundaries()

KOKKOS_INLINE_FUNCTION void Equilibrium::check_boundaries	(	const SimdVector2D &	x,
		Simd< bool > &	rz_outside
	)		const

Check whether vector of (r,z) locations is outside of the equilibrium

Parameters

[in]	x	{r,z} coordinates
[out]	rz_outside	Whether they are outside or not

Here is the call graph for this function:

◆ get_theta()

KOKKOS_INLINE_FUNCTION void Equilibrium::get_theta	(	const SimdVector2D &	x,
		Simd< double > &	theta
	)		const

Gets theta coordinate from {r,z} coordinates

Parameters

[in]	x	{r,z} coordinates
[out]	theta	Vector of theta values

◆ is_above_xpt2_tangent()

KOKKOS_INLINE_FUNCTION bool Equilibrium::is_above_xpt2_tangent	(	double	r,
		double	z
	)		const

Check whether a location is above the line tangent to the second x-point. The tangent is approximated as the line perpendicular to the axis-xpoint line.

Parameters

[in]	r	r coordinate
[in]	z	z coordinate

Returns: True if the location is above the second x-point tangent

◆ is_below_xpt_tangent()

KOKKOS_INLINE_FUNCTION bool Equilibrium::is_below_xpt_tangent	(	double	r,
		double	z
	)		const

Check whether a location is below the line tangent to the x-point. The tangent is approximated as the line perpendicular to the axis-xpoint line.

Parameters

[in]	r	r coordinate
[in]	z	z coordinate

Returns: True if the location is below the x-point tangent

◆ is_in_region_1()

KOKKOS_INLINE_FUNCTION bool Equilibrium::is_in_region_1	(	double	r,
		double	z,
		double	psi
	)		const

Check whether a location is in region 1 of the tokamak

Parameters

[in]	r	r coordinate
[in]	z	z coordinate
[in]	psi	psi coordinate

Returns: True if the location is in region 1

Here is the call graph for this function:

◆ is_in_region_1_or_2()

KOKKOS_INLINE_FUNCTION bool Equilibrium::is_in_region_1_or_2	(	double	r,
		double	z,
		double	psi
	)		const

Check whether a location is in region 1 or 2 of the tokamak

Parameters

[in]	r	r coordinate
[in]	z	z coordinate
[in]	psi	psi coordinate

Returns: True if the location is in region 1 or 2

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_in_region_3b()

KOKKOS_INLINE_FUNCTION bool Equilibrium::is_in_region_3b	(	double	r,
		double	z,
		double	psi
	)		const

Check whether a location is in the second private region

Parameters

[in]	r	r coordinate
[in]	z	z coordinate
[in]	psi	psi coordinate

Returns: True if the location is in second private region

◆ node_region_3_index()

KOKKOS_INLINE_FUNCTION int Equilibrium::node_region_3_index	(	double	r,
		double	z,
		double	psi
	)		const

Returns 0 if in region 3a, 1 if in region 3b, and -1 otherwise

Parameters

[in]	r	r coordinate
[in]	z	z coordinate
[in]	psi	psi coordinate

Returns: int

Here is the call graph for this function:

◆ set_decay_factors()

void Equilibrium::set_decay_factors	(	double	out_decay_factor_in,
		double	priv_flux_decay_factor_in,
		double	out_decay_width_in,
		double	priv_flux_decay_width_in,
		bool	set_xpt2_in
	)

Assigns factors needed for eq profile calculations

◆ write()

void Equilibrium::write	(	const DomainDecomposition< DeviceType > &	pol_decomp,
		const View< double *, CLayout, HostType > &	eq_psi_grid,
		const View< double *, CLayout, HostType > &	eq_I,
		const View< double **, CLayout, HostType > &	eq_psi_rz,
		double	bt_sign,
		double	bp_sign,
		bool	is_3D,
		int	periodicity = `1`,
		int	eq_mp = `1`,
		const View< double **, CLayout, HostType > &	eq_B_R_rz = `View<double**,CLayout,HostType>(NoInit("eq_B_R_rz"), 0, 0)`,
		const View< double **, CLayout, HostType > &	eq_B_Z_rz = `View<double**,CLayout,HostType>(NoInit("eq_B_Z_rz"), 0, 0)`,
		const View< double **, CLayout, HostType > &	eq_B_phi_rz = `View<double**,CLayout,HostType>(NoInit("eq_B_phi_rz"), 0, 0)`,
		const View< double **, CLayout, HostType > &	eq_VMEC_angle_rz = `View<double**,CLayout,HostType>(NoInit("eq_VMEC_angle_rz"), 0, 0)`,
		const View< double **, CLayout, HostType > &	eq_PEST_angle_rz = `View<double**,CLayout,HostType>(NoInit("eq_PEST_angle_rz"), 0, 0)`
	)

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ axis

RZPair Equilibrium::axis

coordinates of axis

◆ axis_b

double Equilibrium::axis_b

magnetic field magnitude on axis

◆ bounds

RZBounds Equilibrium::bounds

Min and max for r and z.

◆ epsil_psi

constexpr double Equilibrium::epsil_psi = 1.0e-05

staticconstexpr

Not sure?

◆ out_decay_factor

double Equilibrium::out_decay_factor

profiles decay exponentially to f(sml_outpsi)/decay_factor for psi>sml_outpsi

◆ out_decay_width

double Equilibrium::out_decay_width

width for exponential decay for psi>sml_outpsi

◆ priv_flux_decay_factor

double Equilibrium::priv_flux_decay_factor

profiles decay exponentially to f(sml_outpsi)/decay_factor in priv. flux region

◆ priv_flux_decay_width

double Equilibrium::priv_flux_decay_width

width for exponential decay in private flux region

◆ psi_norm

double Equilibrium::psi_norm

Psi value to use for normalization.

◆ set_xpt2

bool Equilibrium::set_xpt2

Whether to use a 2nd X-point.

◆ xpt

RZPair Equilibrium::xpt

coordinates of 1st X-point

◆ xpt2

RZPair Equilibrium::xpt2

coordinates of 2nd X-point

◆ xpt2_psi

double Equilibrium::xpt2_psi

psi coordinate at 2nd X-point

◆ xpt2_slope

double Equilibrium::xpt2_slope

Slope (which slope?) at 2nd X-point.

◆ xpt_psi

double Equilibrium::xpt_psi

Psi coordinate of 1st X-point.

◆ xpt_slope

double Equilibrium::xpt_slope

Slope (which slope?) at 1st X-point.

The documentation for this class was generated from the following files:

/p/test_ssd/builds/t3_84szKM/0/xgc/XGC-Devel/XGC_core/cpp/equil.hpp
/p/test_ssd/builds/t3_84szKM/0/xgc/XGC-Devel/XGC_core/cpp/equil.cpp
/p/test_ssd/builds/t3_84szKM/0/xgc/XGC-Devel/XGC_core/cpp/equil.tpp

Public Member Functions

Public Attributes

Static Public Attributes

Constructor & Destructor Documentation

◆ Equilibrium() [1/3]

◆ Equilibrium() [2/3]

◆ Equilibrium() [3/3]

Member Function Documentation

◆ check_boundaries()

◆ get_theta()

◆ is_above_xpt2_tangent()

◆ is_below_xpt_tangent()

◆ is_in_region_1()

◆ is_in_region_1_or_2()

◆ is_in_region_3b()

◆ node_region_3_index()

◆ set_decay_factors()

◆ write()

Member Data Documentation

◆ axis

◆ axis_b

◆ bounds

◆ epsil_psi

◆ out_decay_factor

◆ out_decay_width

◆ priv_flux_decay_factor

◆ priv_flux_decay_width

◆ psi_norm

◆ set_xpt2

◆ xpt

◆ xpt2

◆ xpt2_psi

◆ xpt2_slope

◆ xpt_psi

◆ xpt_slope