Physics::CdrPlasma::CdrPlasmaImExSdcStepper::FieldStorage Class Reference

Field solver scratch storage for the IMEX-SDC time stepper. More...

#include <CD_CdrPlasmaImExSdcStorage.H>

Public Member Functions
	FieldStorage ()
	Default constructor. Leaves all members uninitialised; call allocateStorage() after construction.
	FieldStorage (const RefCountedPtr< AmrMesh > &a_amr, const std::string &a_realm, const phase::which_phase a_phase, const int a_ncomp)
	Full constructor.
	~FieldStorage ()
	Destructor.
void	allocateStorage (const int a_p)
	Allocate all field storage arrays for p+1 SDC nodes.
void	deallocateStorage ()
	Deallocate all field storage arrays.
MFAMRCellData &	getPrevious ()
	Return the multifluid electrostatic potential at the previous time step.
EBAMRCellData &	getElectricFieldCell ()
	Return the cell-centered electric field vector (SpaceDim components).
EBAMRFluxData &	getElectricFieldFace ()
	Return the face-centered normal electric field component.
EBAMRIVData &	getElectricFieldEb ()
	Return the EB-centroid-centered electric field vector.
EBAMRIFData &	getElectricFieldDomain ()
	Return the domain-face-centered electric field vector.

Protected Attributes
std::string	m_realm
	Realm on which storage is allocated.
RefCountedPtr< AmrMesh >	m_amr
	AMR mesh used for allocation.
phase::which_phase	m_phase
	Phase on which storage is allocated.
int	m_ncomp
	Number of field components (SpaceDim).
int	m_p
	Number of SDC subintervals.
MFAMRCellData	m_previous
	Multifluid cell-centered electrostatic potential at the previous time step.
EBAMRCellData	m_E_cell
	Cell-centered electric field vector (SpaceDim components).
EBAMRFluxData	m_E_face
	Face-centered normal component of the electric field.
EBAMRIVData	m_E_eb
	EB-centroid-centered electric field vector (SpaceDim components).
EBAMRIFData	m_E_dom
	Domain-face-centered electric field vector (SpaceDim components).

Detailed Description

Field solver scratch storage for the IMEX-SDC time stepper.

Holds the electrostatic potential at the previous step, and the electric field at all locations needed by the CDR and surface charge solvers: cell centers, face centers, EB centroids, and domain faces.

Constructor & Destructor Documentation

FieldStorage()

CdrPlasmaImExSdcStepper::FieldStorage::FieldStorage	(	const RefCountedPtr< AmrMesh > &	a_amr,
		const std::string &	a_realm,
		const phase::which_phase	a_phase,
		const int	a_ncomp
	)

Full constructor.

Parameters

[in]	a_amr	AMR mesh used to allocate data.
[in]	a_realm	Realm on which storage is allocated.
[in]	a_phase	Phase on which storage is allocated.
[in]	a_ncomp	Number of components (SpaceDim for the electric field).

Member Function Documentation

allocateStorage()

void CdrPlasmaImExSdcStepper::FieldStorage::allocateStorage

(

const int

a_p

)

Allocate all field storage arrays for p+1 SDC nodes.

Parameters

[in]

a_p

Number of SDC subintervals.

getElectricFieldCell()

EBAMRCellData & Physics::CdrPlasma::CdrPlasmaImExSdcStepper::FieldStorage::getElectricFieldCell ( )

inline

Return the cell-centered electric field vector (SpaceDim components).

Returns

Reference to m_E_cell.

getElectricFieldDomain()

EBAMRIFData & Physics::CdrPlasma::CdrPlasmaImExSdcStepper::FieldStorage::getElectricFieldDomain ( )

inline

Return the domain-face-centered electric field vector.

Returns

Reference to m_E_dom.

getElectricFieldEb()

EBAMRIVData & Physics::CdrPlasma::CdrPlasmaImExSdcStepper::FieldStorage::getElectricFieldEb ( )

inline

Return the EB-centroid-centered electric field vector.

Returns

Reference to m_E_eb.

getElectricFieldFace()

EBAMRFluxData & Physics::CdrPlasma::CdrPlasmaImExSdcStepper::FieldStorage::getElectricFieldFace ( )

inline

Return the face-centered normal electric field component.

Returns

Reference to m_E_face.

getPrevious()

MFAMRCellData & Physics::CdrPlasma::CdrPlasmaImExSdcStepper::FieldStorage::getPrevious ( )

inline

Return the multifluid electrostatic potential at the previous time step.

Returns

Reference to m_previous.

---

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

• Physics/CdrPlasma/Timesteppers/CdrPlasmaImExSdcStepper/CD_CdrPlasmaImExSdcStorage.H
• Physics/CdrPlasma/Timesteppers/CdrPlasmaImExSdcStepper/CD_CdrPlasmaImExSdcStorage.cpp