Physics::CdrPlasma::CdrPlasmaGodunovStepper::FieldStorage Class Reference

Utility class for memory handling in CdrPlasmaStepper. More...

#include <CD_CdrPlasmaGodunovStorage.H>

Public Member Functions
	FieldStorage ()=delete
	Disallowed weak constructor.
	FieldStorage (const RefCountedPtr< AmrMesh > &a_amr, const std::string &a_realm, phase::which_phase a_phase)
	Full constructor. Can call allocation functions after this.
virtual	~FieldStorage ()
	Destructor.
	FieldStorage (const FieldStorage &)=delete
FieldStorage &	operator= (const FieldStorage &)=delete
	FieldStorage (FieldStorage &&)=delete
FieldStorage &	operator= (FieldStorage &&)=delete
virtual void	allocateStorage ()
	Allocation function – allocates all the necessary memory.
virtual void	deallocateStorage ()
	Deallocation function – deallocates all the necessary memory.
EBAMRCellData &	getElectricFieldCell () const
	Get scratch storage that holds the electric field at the cell center.
EBAMRIVData &	getElectricFieldEB () const
	Get scratch storage that holds the electric field at the EB.
EBAMRIFData &	getElectricFieldDomain () const
	Get scratch storage that holds the electric field at the domainf aces.

Protected Attributes
RefCountedPtr< AmrMesh >	m_amr
	Reference to AmrMesh.
std::string	m_realm
	Realm where data lives.
phase::which_phase	m_phase
	Phase where data lives.
EBAMRCellData	m_electricFieldCell
	Scratch storage for holding electric field at cell center.
EBAMRIVData	m_electricFieldEB
	Scratch storage for holding electric field at the EB.
EBAMRIFData	m_electricFieldDomain
	Scratch storage for holding electric field at domain faces.

Detailed Description

Utility class for memory handling in CdrPlasmaStepper.

This class exists because we often need some extra storage when advancing the equations.

Constructor & Destructor Documentation

FieldStorage()

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

Full constructor. Can call allocation functions after this.

Parameters

[in]	a_amr	Reference to AmrMesh
[in]	a_realm	Realm where storage lives
[in]	a_phase	Phase where storage lives (only single-phased data in here)

Member Function Documentation

getElectricFieldCell()

EBAMRCellData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::FieldStorage::getElectricFieldCell ( ) const

inline

Get scratch storage that holds the electric field at the cell center.

Returns

Electric field cell

getElectricFieldDomain()

EBAMRIFData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::FieldStorage::getElectricFieldDomain ( ) const

inline

Get scratch storage that holds the electric field at the domainf aces.

Returns

Electric field domain

getElectricFieldEB()

EBAMRIVData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::FieldStorage::getElectricFieldEB ( ) const

inline

Get scratch storage that holds the electric field at the EB.

Returns

Electric field e b

---

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

• Physics/CdrPlasma/Timesteppers/CdrPlasmaGodunovStepper/CD_CdrPlasmaGodunovStorage.H
• Physics/CdrPlasma/Timesteppers/CdrPlasmaGodunovStepper/CD_CdrPlasmaGodunovStorage.cpp