Neutrals Class Reference

#include <neutrals.hpp>

Inheritance diagram for Neutrals:

Collaboration diagram for Neutrals:

Public Member Functions
	Neutrals (int nthreads, int nbins, int nnode, NLReader::NamelistReader &nlr, double sml_dt, double transit_time)
	Neutrals ()
void	diag (const DomainDecomposition< DeviceType > &pol_decomp, int gstep, const View< double *, CLayout, HostType > &n_neut, const View< double *, CLayout, HostType > &T_neut) const
void	write_checkpoint_files (const XGC_IO_Stream &stream) const
void	read_checkpoint_files (const XGC_IO_Stream &stream) const
void	copy_to_host () const
void	clear_device_views () const
void	clear_host_views () const
void	apply (const Grid< DeviceType > &grid, const DomainDecomposition< DeviceType > &pol_decomp, const VelocityGrid &vgrid, Plasma &plasma, const VGridDistribution< DeviceType > &f0_f, const VGridDistribution< HostType > &f0_f_h, VGridDistribution< DeviceType > &f0_df0g_cumul, const int axisym_parallelization_int, int gstep, DiagF0DF &diag_f0_df, double dt) const
Public Member Functions inherited from Source
bool	is_triggered (int step)

Public Attributes
WallLoss	wall_loss
int	background_period
StepTrigger	trigger_neutral_update
View< double *, CLayout, HostType >	weight_sum_lost_h
	Array to store how much was lost in total at the sheath. More...
View< double *, CLayout, HostType >	weight_wall_lost_h
	Array to store how much was lost at the sheath, binned by wall index. More...
View< double **, CLayout, HostType >	weight_lost_ebin_h
	Array to store how much was lost at the sheath, binned by wall and energy index. More...
View< double *, CLayout, HostType >	node_dens_h
View< double *, CLayout, HostType >	node_temp_h
StepTrigger	trigger_diag
std::shared_ptr< XGC_IO_Stream >	io_stream
Public Attributes inherited from Source
StepTrigger	step_trigger

Constructor & Destructor Documentation

Neutrals() [1/2]

Neutrals::Neutrals	(	int	nthreads,
		int	nbins,
		int	nnode,
		NLReader::NamelistReader &	nlr,
		double	sml_dt,
		double	transit_time
	)

Constructor for neutrals

< The number of discrete timesteps between writing the neutral output files. Should generally be equal to neu_background_period.

Here is the call graph for this function:

Neutrals() [2/2]

Neutrals::Neutrals ( )

inline

Member Function Documentation

apply()

void Neutrals::apply	(	const Grid< DeviceType > &	grid,
		const DomainDecomposition< DeviceType > &	pol_decomp,
		const VelocityGrid &	vgrid,
		Plasma &	plasma,
		const VGridDistribution< DeviceType > &	f0_f,
		const VGridDistribution< HostType > &	f0_f_h,
		VGridDistribution< DeviceType > &	f0_df0g_cumul,
		const int	axisym_parallelization_int,
		int	gstep,
		DiagF0DF &	diag_f0_df,
		double	dt
	)		const

Here is the call graph for this function:

Here is the caller graph for this function:

clear_device_views()

void Neutrals::clear_device_views

(

)

const

Here is the caller graph for this function:

clear_host_views()

void Neutrals::clear_host_views

(

)

const

Here is the caller graph for this function:

copy_to_host()

void Neutrals::copy_to_host

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

diag()

void Neutrals::diag	(	const DomainDecomposition< DeviceType > &	pol_decomp,
		int	gstep,
		const View< double *, CLayout, HostType > &	n_neut,
		const View< double *, CLayout, HostType > &	T_neut
	)		const

Here is the call graph for this function:

Here is the caller graph for this function:

read_checkpoint_files()

void Neutrals::read_checkpoint_files

(

const XGC_IO_Stream &

stream

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

write_checkpoint_files()

void Neutrals::write_checkpoint_files

(

const XGC_IO_Stream &

stream

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

background_period

int Neutrals::background_period

io_stream

std::shared_ptr<XGC_IO_Stream> Neutrals::io_stream

node_dens_h

View<double*,CLayout,HostType> Neutrals::node_dens_h

node_temp_h

View<double*,CLayout,HostType> Neutrals::node_temp_h

trigger_diag

StepTrigger Neutrals::trigger_diag

trigger_neutral_update

StepTrigger Neutrals::trigger_neutral_update

wall_loss

WallLoss Neutrals::wall_loss

weight_lost_ebin_h

View<double**,CLayout,HostType> Neutrals::weight_lost_ebin_h

Array to store how much was lost at the sheath, binned by wall and energy index.

weight_sum_lost_h

View<double*,CLayout,HostType> Neutrals::weight_sum_lost_h

Array to store how much was lost in total at the sheath.

weight_wall_lost_h

View<double*,CLayout,HostType> Neutrals::weight_wall_lost_h

Array to store how much was lost at the sheath, binned by wall index.

---

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

• /p/test_ssd/builds/t3_84szKM/0/xgc/XGC-Devel/XGC_core/cpp/neutrals.hpp
• /p/test_ssd/builds/t3_84szKM/0/xgc/XGC-Devel/XGC_core/cpp/neutrals.cpp