projects Namespace Reference

Classes
struct	AlfvenSpeciesParameters
class	Alfven
struct	DiffusionSpeciesParameters
class	Diffusion
struct	DispersionSpeciesParameters
class	Dispersion
class	Distributions
struct	FirehoseSpeciesParameters
class	Firehose
struct	FlowthroughSpeciesParameters
class	Flowthrough
struct	FluctuationsSpeciesParameters
class	Fluctuations
struct	HarrisSpeciesParameters
class	Harris
struct	IPShockSpeciesParameters
class	IPShock
class	KHB
class	Larmor
struct	LossConeSpeciesParameters
class	LossCone
struct	MagnetosphereSpeciesParameters
class	Magnetosphere
struct	MultiPeakSpeciesParameters
class	MultiPeak
class	Project
class	TriAxisSearch
struct	GaussianPopulation
class	ReadGaussianPopulation
class	Riemann1
class	Shock
class	Shocktest
class	Template
class	test_fp
class	TestHall
class	verificationLarmor

Enumerations

enum

Neighbours {   ZM1_YM1_XM1 , ZM1_YM1_XCC , ZM1_YM1_XP1 , ZM1_YCC_XM1 ,   ZM1_YCC_XCC , ZM1_YCC_XP1 , ZM1_YP1_XM1 , ZM1_YP1_XCC ,   ZM1_YP1_XP1 , ZCC_YM1_XM1 , ZCC_YM1_XCC , ZCC_YM1_XP1 ,   ZCC_YCC_XM1 , ZCC_YCC_XCC , ZCC_YCC_XP1 , ZCC_YP1_XM1 ,   ZCC_YP1_XCC , ZCC_YP1_XP1 , ZP1_YM1_XM1 , ZP1_YM1_XCC ,   ZP1_YM1_XP1 , ZP1_YCC_XM1 , ZP1_YCC_XCC , ZP1_YCC_XP1 ,   ZP1_YP1_XM1 , ZP1_YP1_XCC , ZP1_YP1_XP1 }

Functions
Project *	createProject ()
ARCH_HOSTDEV Realf	MaxwellianPhaseSpaceDensity (creal &vx, creal &vy, creal &vz, creal &T, creal &rho, creal &mass)
ARCH_HOSTDEV Realf	TriMaxwellianPhaseSpaceDensity (creal &vx, creal &vy, creal &vz, creal &Tx, creal &Ty, creal &Tz, creal &rho, creal &mass)

Variables
const uint	MISSING_ZNEG = (1 << projects::ZM1_YCC_XCC)
const uint	MISSING_YNEG = (1 << projects::ZCC_YM1_XCC)
const uint	MISSING_XNEG = (1 << projects::ZCC_YCC_XM1)
const uint	MISSING_XPOS = (1 << projects::ZCC_YCC_XP1)
const uint	MISSING_YPOS = (1 << projects::ZCC_YP1_XCC)
const uint	MISSING_ZPOS = (1 << projects::ZP1_YCC_XCC)
const uint	FACE_NBR_BITMASK = (MISSING_ZNEG | MISSING_YNEG | MISSING_XNEG | MISSING_XPOS | MISSING_YPOS | MISSING_ZPOS)

Enumeration Type Documentation

Neighbours

enum projects::Neighbours

Enumerator
ZM1_YM1_XM1
ZM1_YM1_XCC
ZM1_YM1_XP1
ZM1_YCC_XM1
ZM1_YCC_XCC
ZM1_YCC_XP1
ZM1_YP1_XM1
ZM1_YP1_XCC
ZM1_YP1_XP1
ZCC_YM1_XM1
ZCC_YM1_XCC
ZCC_YM1_XP1
ZCC_YCC_XM1
ZCC_YCC_XCC
ZCC_YCC_XP1
ZCC_YP1_XM1
ZCC_YP1_XCC
ZCC_YP1_XP1
ZP1_YM1_XM1
ZP1_YM1_XCC
ZP1_YM1_XP1
ZP1_YCC_XM1
ZP1_YCC_XCC
ZP1_YCC_XP1
ZP1_YP1_XM1
ZP1_YP1_XCC
ZP1_YP1_XP1

Definition at line 30 of file projects_common.h.

Function Documentation

createProject()

Project * projects::createProject

(

)

Definition at line 649 of file project.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

MaxwellianPhaseSpaceDensity()

ARCH_HOSTDEV Realf projects::MaxwellianPhaseSpaceDensity ( creal & vx, creal & vy, creal & vz, creal & T, creal & rho, creal & mass )

inline

Returns the phase-space density of a Maxwellian distribution function NOTE: This function is called inside parallel region so it must be declared as const.

Parameters

vx	The vx-coordinate relative to the Maxwellian centre
vy	The vy-coordinate relative to the Maxwellian centre
vz	The vz-coordinate relative to the Maxwellian centre
T	The Maxwellian temperature
rho	The total number density of the Maxwellian distribution
mass	The mass of the particle in question

Returns

The distribution function value at the given velocity coordinates The physical unit of this quantity is 1 / (m^3 (m/s)^3).

Definition at line 45 of file project.h.

Here is the caller graph for this function:

TriMaxwellianPhaseSpaceDensity()

ARCH_HOSTDEV Realf projects::TriMaxwellianPhaseSpaceDensity ( creal & vx, creal & vy, creal & vz, creal & Tx, creal & Ty, creal & Tz, creal & rho, creal & mass )

inline

Returns the phase-space density of a Tri-Maxwellian distribution function NOTE: This function is called inside parallel region so it must be declared as const.

Parameters

vx	The vx-coordinate relative to the Tri-Maxwellian centre
vy	The vy-coordinate relative to the Tri-Maxwellian centre
vz	The vz-coordinate relative to the Tri-Maxwellian centre
Tx	The Tri-Maxwellian x-directional temperature
Ty	The Tri-Maxwellian y-directional temperature
Tz	The Tri-Maxwellian z-directional temperature
rho	The total number density of the Tri-Maxwellian distribution
mass	The mass of the particle in question

Returns

The distribution function value at the given velocity coordinates The physical unit of this quantity is 1 / (m^3 (m/s)^3).

Definition at line 66 of file project.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

FACE_NBR_BITMASK

const uint projects::FACE_NBR_BITMASK = (MISSING_ZNEG | MISSING_YNEG | MISSING_XNEG | MISSING_XPOS | MISSING_YPOS | MISSING_ZPOS)

Definition at line 66 of file projects_common.h.

MISSING_XNEG

const uint projects::MISSING_XNEG = (1 << projects::ZCC_YCC_XM1)

Definition at line 62 of file projects_common.h.

MISSING_XPOS

const uint projects::MISSING_XPOS = (1 << projects::ZCC_YCC_XP1)

Definition at line 63 of file projects_common.h.

MISSING_YNEG

const uint projects::MISSING_YNEG = (1 << projects::ZCC_YM1_XCC)

Definition at line 61 of file projects_common.h.

MISSING_YPOS

const uint projects::MISSING_YPOS = (1 << projects::ZCC_YP1_XCC)

Definition at line 64 of file projects_common.h.

MISSING_ZNEG

const uint projects::MISSING_ZNEG = (1 << projects::ZM1_YCC_XCC)

Definition at line 60 of file projects_common.h.

MISSING_ZPOS

const uint projects::MISSING_ZPOS = (1 << projects::ZP1_YCC_XCC)

Definition at line 65 of file projects_common.h.