Physics::CdrPlasma::CdrPlasmaGodunovStepper::SigmaStorage Class Reference

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

#include <CD_CdrPlasmaGodunovStorage.H>

Public Member Functions
	SigmaStorage ()=delete
	Disallowed weak constructor. Use full construction.
	SigmaStorage (const RefCountedPtr< AmrMesh > &a_amr, const std::string &a_realm, phase::which_phase a_phase)
	Full constructor. Can call allocation functions after this.
virtual	~SigmaStorage ()
	Destructor.
	SigmaStorage (const SigmaStorage &)=delete
SigmaStorage &	operator= (const SigmaStorage &)=delete
	SigmaStorage (SigmaStorage &&)=delete
SigmaStorage &	operator= (SigmaStorage &&)=delete
virtual void	allocateStorage ()
	Allocation function – allocates the storage.
virtual void	deallocateStorage ()
	Allocation function – deallocates the storage.
EBAMRIVData &	getScratch () const
	Get scratch data.

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.
EBAMRIVData	m_scratch
	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

SigmaStorage()

CdrPlasmaGodunovStepper::SigmaStorage::SigmaStorage	(	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

getScratch()

EBAMRIVData & Physics::CdrPlasma::CdrPlasmaGodunovStepper::SigmaStorage::getScratch ( ) const

inline

Get scratch data.

Returns

Scratch

---

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