#include <testHall.h>

Inheritance diagram for projects::TestHall:

Collaboration diagram for projects::TestHall:

Public Member Functions
	TestHall ()
virtual	~TestHall ()
virtual bool	initialize (void) override
virtual void	getParameters (void) override
virtual void	calcCellParameters (spatial_cell::SpatialCell *cell, creal &t) 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
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
bool	noDipoleInSW
Real	constBgB [3]
Real	dipoleScalingFactor
Real	dipoleTilt
Real	BX0
Real	BY0
Real	BZ0
Real	VX0
Real	VY0
Real	VZ0
Real	TEMPERATURE
Real	DENSITY

Additional Inherited Members
Protected Member Functions inherited from projects::Project
virtual uint	findBlocksToInitialize (spatial_cell::SpatialCell *cell, const uint popID) const
	Prepares a list of blocks to loop through when initialising.
void	setVelocitySpace (const uint popID, spatial_cell::SpatialCell *cell) const
	Sets the distribution function in a cell.
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 testHall.h.

Constructor & Destructor Documentation

◆ TestHall()

projects::TestHall::TestHall ( )

Definition at line 38 of file testHall.cpp.

Here is the call graph for this function:

◆ ~TestHall()

projects::TestHall::~TestHall ( )

virtual

Definition at line 39 of file testHall.cpp.

Member Function Documentation

◆ addParameters()

void projects::TestHall::addParameters ( void )

static

Definition at line 52 of file testHall.cpp.

Here is the caller graph for this function:

◆ calcCellParameters()

void projects::TestHall::calcCellParameters	(	spatial_cell::SpatialCell *	cell,
		creal &	t )

overridevirtual

Calculate potentially needed parameters for the given spatial cell at the given time.

Currently this function is only called during initialization.

The following array indices contain the coordinates of the "lower left corner" of the cell: CellParams::XCRD, CellParams::YCRD, and CellParams::ZCRD. The cell size is given in the following array indices: CellParams::DX, CellParams::DY, and CellParams::DZ.

Parameters

cell	Pointer to the spatial cell to be handled.
t	The current value of time. This is passed as a convenience. If you need more detailed information of the state of the simulation, you can read it from Parameters.

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

Reimplemented from projects::Project.

Definition at line 135 of file testHall.cpp.

◆ fillPhaseSpace()

Realf projects::TestHall::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 82 of file testHall.cpp.

Here is the call graph for this function:

◆ getParameters()

void projects::TestHall::getParameters ( void )

overridevirtual

Get the value that was read in.

Reimplemented from projects::Project.

Definition at line 64 of file testHall.cpp.

Here is the call graph for this function:

◆ initialize()

bool projects::TestHall::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 41 of file testHall.cpp.

Here is the call graph for this function:

◆ setProjectBField()

void projects::TestHall::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 137 of file testHall.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ BX0

Real projects::TestHall::BX0

Definition at line 50 of file testHall.h.

◆ BY0

Real projects::TestHall::BY0

Definition at line 51 of file testHall.h.

◆ BZ0

Real projects::TestHall::BZ0

Definition at line 52 of file testHall.h.

◆ constBgB

Real projects::TestHall::constBgB[3]

Definition at line 47 of file testHall.h.

◆ DENSITY

Real projects::TestHall::DENSITY

Definition at line 57 of file testHall.h.

◆ dipoleScalingFactor

Real projects::TestHall::dipoleScalingFactor

Definition at line 48 of file testHall.h.

◆ dipoleTilt

Real projects::TestHall::dipoleTilt

Definition at line 49 of file testHall.h.

◆ noDipoleInSW

bool projects::TestHall::noDipoleInSW

Definition at line 46 of file testHall.h.

◆ TEMPERATURE

Real projects::TestHall::TEMPERATURE

Definition at line 56 of file testHall.h.

◆ VX0

Real projects::TestHall::VX0

Definition at line 53 of file testHall.h.

◆ VY0

Real projects::TestHall::VY0

Definition at line 54 of file testHall.h.

◆ VZ0

Real projects::TestHall::VZ0

Definition at line 55 of file testHall.h.

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

projects/testHall/testHall.h
projects/testHall/testHall.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TestHall()

◆ ~TestHall()

Member Function Documentation

◆ addParameters()

◆ calcCellParameters()

◆ fillPhaseSpace()

◆ getParameters()

◆ initialize()

◆ setProjectBField()

Member Data Documentation

◆ BX0

◆ BY0

◆ BZ0

◆ constBgB

◆ DENSITY

◆ dipoleScalingFactor

◆ dipoleTilt

◆ noDipoleInSW

◆ TEMPERATURE

◆ VX0

◆ VY0

◆ VZ0