#include <Template.h>

Inheritance diagram for projects::Template:

[legend]

Collaboration diagram for projects::Template:

[legend]

Public Member Functions
	Template ()
virtual	~Template ()
virtual bool	initialize (void) override
virtual void	getParameters (void) override
virtual void	setProjectBField (fsgrids::perbspan perb, fsgrids::bgbspan bgb, fsgrids::technicalspan technical, FieldSolverGrid &fsgrid) override
virtual Realf	fillPhaseSpace (spatial_cell::SpatialCell *cell, const uint popID, const uint nRequested) const override
virtual Realf	probePhaseSpace (spatial_cell::SpatialCell *cell, const uint popID, Real vx_in, Real vy_in, Real vz_in) const override
virtual std::vector< std::array< Real, 3 > >	getV0 (creal x, creal y, creal z, const uint popID) const override
	Return a vector containing the velocity coordinate of the centre of each ion population in the distribution.
Public Member Functions inherited from projects::Project
	Project ()
virtual	~Project ()
virtual Real	getCorrectNumberDensity (spatial_cell::SpatialCell *cell, const uint popID) const
virtual void	hook (cuint &stage, const dccrg::Dccrg< spatial_cell::SpatialCell, dccrg::Cartesian_Geometry > &mpiGrid, fsgrids::perbspan perb, fsgrids::technicalspan technical, FieldSolverGrid &fsgrid) const
bool	initialized ()
virtual void	setupBeforeSetCell (const std::vector< CellID > &cells)
void	setCell (spatial_cell::SpatialCell *cell)
	Set the perturbed fields and distribution of a cell according to the default simulation settings. This is used for the NOT_SYSBOUNDARY cells and some other system boundary conditions (e.g. Outflow).
virtual bool	canRefine (spatial_cell::SpatialCell *cell) const
virtual bool	shouldRefineCell (dccrg::Dccrg< spatial_cell::SpatialCell, dccrg::Cartesian_Geometry > &mpiGrid, CellID id, Real r_max2) const
virtual bool	shouldUnrefineCell (dccrg::Dccrg< spatial_cell::SpatialCell, dccrg::Cartesian_Geometry > &mpiGrid, CellID id, Real r_max2) const
virtual bool	refineSpatialCells (dccrg::Dccrg< spatial_cell::SpatialCell, dccrg::Cartesian_Geometry > &mpiGrid) const
virtual uint64_t	adaptRefinement (dccrg::Dccrg< spatial_cell::SpatialCell, dccrg::Cartesian_Geometry > &mpiGrid) const
	Adapts refinement by one level according to the project. Returns true if any cells were refined, false if not.
virtual bool	forceRefinement (dccrg::Dccrg< spatial_cell::SpatialCell, dccrg::Cartesian_Geometry > &mpiGrid, int n) const
	Refine/unrefine spatial cells one level to the static criteria in the config.
virtual bool	filterRefined (dccrg::Dccrg< spatial_cell::SpatialCell, dccrg::Cartesian_Geometry > &mpiGrid) const
	Boxcar filters spatial cells that were recently refined.

Static Public Member Functions
static void	addParameters (void)
Static Public Member Functions inherited from projects::Project
static void	addParameters ()

Public Attributes
Real	param

Additional Inherited Members
Protected Member Functions inherited from projects::TriAxisSearch
virtual uint	findBlocksToInitialize (spatial_cell::SpatialCell *cell, const uint popID) const
	Find blocks above the threshold centred isotropically around a bulk velocity.
Protected Member Functions inherited from projects::Project
void	setVelocitySpace (const uint popID, spatial_cell::SpatialCell *cell) const
	Sets the distribution function in a cell.
virtual void	calcCellParameters (spatial_cell::SpatialCell *cell, creal &t)
void	printPopulations ()
virtual bool	rescalesDensity (const uint popID) const
void	rescaleDensity (spatial_cell::SpatialCell *cell, const uint popID) const
Real	getRandomNumber (std::default_random_engine &randGen) const
void	setRandomSeed (uint64_t seedModifier, std::default_random_engine &randGen) const
void	setRandomCellSeed (spatial_cell::SpatialCell *cell, std::default_random_engine &randGen) const

Detailed Description

Definition at line 30 of file Template.h.

Constructor & Destructor Documentation

◆ Template()

projects::Template::Template ( )

Definition at line 39 of file Template.cpp.

◆ ~Template()

projects::Template::~Template ( )

virtual

Definition at line 40 of file Template.cpp.

Member Function Documentation

◆ addParameters()

void projects::Template::addParameters ( void )

static

Definition at line 42 of file Template.cpp.

Here is the caller graph for this function:

◆ fillPhaseSpace()

Realf projects::Template::fillPhaseSpace	(	spatial_cell::SpatialCell *	cell,
		const uint	popID,
		const uint	nRequested ) const

overridevirtual

Calculates the distribution function contents for the spatial cell and population in question NOTE: This function is called inside parallel region so it must be declared as const. This function will contain a loop over nRequested velocity blocks, with the block GlobalIDs provided in the GIDlist buffer, storing phase-space densities in the bufferData buffer.

Parameters

popID Particle species ID.

Returns: The total stored number density of the cell for this population The physical unit of this quantity is 1/m^3.

Implements projects::Project.

Definition at line 59 of file Template.cpp.

Here is the call graph for this function:

◆ getParameters()

void projects::Template::getParameters ( void )

overridevirtual

Get the value that was read in.

Reimplemented from projects::Project.

Definition at line 47 of file Template.cpp.

Here is the call graph for this function:

◆ getV0()

vector< std::array< Real, 3 > > projects::Template::getV0	(	creal	x,
		creal	y,
		creal	z,
		const uint	popID ) const

overridevirtual

Return a vector containing the velocity coordinate of the centre of each ion population in the distribution.

This function is used by findBlocksToInitialize() to start the search of the extent of the distribution along each axis. The extension to a vector allows to have more than one population in each spatial cell.

See also: findBlocksToInitialize

Implements projects::TriAxisSearch.

Definition at line 147 of file Template.cpp.

Here is the caller graph for this function:

◆ initialize()

bool projects::Template::initialize ( void )

overridevirtual

Initialize project. Can be used, e.g., to read in parameters from the input file.

Initialize the Project. Velocity mesh and particle population parameters are read from the configuration file, and corresponding internal variables are created here. NOTE: Each project must call this function!

Returns: If true, particle species and velocity meshes were created successfully.

Reimplemented from projects::Project.

Definition at line 54 of file Template.cpp.

Here is the call graph for this function:

◆ probePhaseSpace()

Realf projects::Template::probePhaseSpace	(	spatial_cell::SpatialCell *	cell,
		const uint	popID,
		Real	vx_in,
		Real	vy_in,
		Real	vz_in ) const

overridevirtual

Implements projects::TriAxisSearch.

Definition at line 117 of file Template.cpp.

Here is the call graph for this function:

◆ setProjectBField()

void projects::Template::setProjectBField	(	fsgrids::perbspan	perb,
		fsgrids::bgbspan	bgb,
		fsgrids::technicalspan	technical,
		FieldSolverGrid &	fsgrid )

overridevirtual

Set the background and perturbed magnetic fields for this project.

Parameters

perBGrid	Grid on which values of the perturbed field can be set if needed.
BgBGrid	Grid on which values for the background field can be set if needed, e.g. using the background field functions.
technical	Technical fsgrid, available if some of its data is necessary.

See also: setBackgroundField, setBackgroundFieldToZero

Print a warning message to stderr and abort, one should not use the base class functions.

Reimplemented from projects::Project.

Definition at line 139 of file Template.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ param

Real projects::Template::param

Definition at line 48 of file Template.h.

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

projects/Template/Template.h
projects/Template/Template.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Template()

◆ ~Template()

Member Function Documentation

◆ addParameters()

◆ fillPhaseSpace()

◆ getParameters()

◆ getV0()

◆ initialize()

◆ probePhaseSpace()

◆ setProjectBField()

Member Data Documentation

◆ param