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

#include <CD_CdrPlasmaGodunovStorage.H>

Public Member Functions
	CdrStorage ()=delete
	Disallowed constructor. Only strong construction allowed.

	CdrStorage (const RefCountedPtr< AmrMesh > &a_amr, const std::string &a_realm, phase::which_phase a_phase)
	Full constructor. After this, user may call allocateStorage and deallocateStorage.

virtual	~CdrStorage ()
	Destructor.

	CdrStorage (const CdrStorage &)=delete

CdrStorage &	operator= (const CdrStorage &)=delete

	CdrStorage (CdrStorage &&)=delete

CdrStorage &	operator= (CdrStorage &&)=delete

virtual void	allocateStorage ()
	Allocation function. This will allocate all transient storage in this class.

virtual void	deallocateStorage ()
	Allocation function. This will delete all transient storage in this class.

EBAMRCellData &	getScratch () const
	Get scratch storage.

EBAMRCellData &	getScratch2 () const
	Get the other scratch storage.

EBAMRCellData &	getExtrap () const
	Get the extrapolation storage. This is usually used for holding phi + 0.5dtS.

EBAMRCellData &	getGradient () const
	Get storage for holding gradient.

EBAMRIVData &	getEbState () const
	Get scratch storage that holds the density on the EB.

EBAMRIVData &	getEbVelo () const
	Get the scratch storage holding the normal component of the velocity on the EB.

EBAMRIVData &	getEbFlux () const
	Get the scratch storage holding the extrapolated flux on the EB.

EBAMRIVData &	getEbGrad () const
	Get the scratch storage holding the extrapolated gradient on the EB.

EBAMRIFData &	getDomainState () const
	Get the scratch storage holding the extrapolated density on domain faces.

EBAMRIFData &	getDomainVelo () const
	Get the scratch storage holding the extrapolated velocity (normal component only) on domain faces.

EBAMRIFData &	getDomainFlux () const
	Get the scratch storage holding the extrapolated flux on domain faces.

EBAMRIFData &	getDomainGrad () const
	Get the scratch storage holding the extrapolated gradient (normal component only) on domain faces.

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_scratch
	Cell-centered scratch data.

EBAMRCellData	m_scratch2
	Cell-centered scratch data.

EBAMRCellData	m_cellExtr
	Cell-centered scratch data. Used for holding phi + 0.5dtS.

EBAMRCellData	m_gradient
	Cell-centered scratch data for holding the gradient.

EBAMRIVData	m_scratchIV1
	EB-centered scratch data.

EBAMRIVData	m_scratchIV2
	EB-centered scratch data.

EBAMRIVData	m_scratchIV3
	EB-centered scratch data.

EBAMRIVData	m_scratchIV4
	EB-centered scratch data.

EBAMRIFData	m_scratchIF1
	Domain-centered scratch data.

EBAMRIFData	m_scratchIF2
	Domain-centered scratch data.

EBAMRIFData	m_scratchIF3
	Domain-centered scratch data.

EBAMRIFData	m_scratchIF4
	Domain-centered scratch data.

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

◆ CdrStorage()

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

Full constructor. After this, user may call allocateStorage and deallocateStorage.

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

◆ getDomainFlux()

EBAMRIFData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getDomainFlux ( ) const

inline

Get the scratch storage holding the extrapolated flux on domain faces.

Returns: Domain flux

◆ getDomainGrad()

EBAMRIFData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getDomainGrad ( ) const

inline

Get the scratch storage holding the extrapolated gradient (normal component only) on domain faces.

Returns: Domain grad

◆ getDomainState()

EBAMRIFData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getDomainState ( ) const

inline

Get the scratch storage holding the extrapolated density on domain faces.

Returns: Domain state

◆ getDomainVelo()

EBAMRIFData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getDomainVelo ( ) const

inline

Get the scratch storage holding the extrapolated velocity (normal component only) on domain faces.

Returns: Domain velo

◆ getEbFlux()

EBAMRIVData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getEbFlux ( ) const

inline

Get the scratch storage holding the extrapolated flux on the EB.

Returns: Eb flux

◆ getEbGrad()

EBAMRIVData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getEbGrad ( ) const

inline

Get the scratch storage holding the extrapolated gradient on the EB.

Returns: Eb grad

◆ getEbState()

EBAMRIVData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getEbState ( ) const

inline

Get scratch storage that holds the density on the EB.

Returns: Eb state

◆ getEbVelo()

EBAMRIVData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getEbVelo ( ) const

inline

Get the scratch storage holding the normal component of the velocity on the EB.

Returns: Eb velo

◆ getExtrap()

EBAMRCellData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getExtrap ( ) const

inline

Get the extrapolation storage. This is usually used for holding phi + 0.5*dt*S.

Returns: Extrap

◆ getGradient()

EBAMRCellData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getGradient ( ) const

inline

Get storage for holding gradient.

Returns: Gradient

◆ getScratch()

EBAMRCellData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getScratch ( ) const

inline

Get scratch storage.

Returns: Scratch

◆ getScratch2()

EBAMRCellData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::CdrStorage::getScratch2 ( ) const

inline

Get the other scratch storage.

Returns: Scratch2

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CdrStorage()

Member Function Documentation

◆ getDomainFlux()

◆ getDomainGrad()

◆ getDomainState()

◆ getDomainVelo()

◆ getEbFlux()

◆ getEbGrad()

◆ getEbState()

◆ getEbVelo()

◆ getExtrap()

◆ getGradient()

◆ getScratch()

◆ getScratch2()