Class for holding a set of RtSolvers. T must derive from RtSolver. More...

#include <CD_RtLayout.H>

Public Member Functions
	RtLayout (const Vector< RefCountedPtr< RtSpecies > > &a_RtSpecies)
	Full constructor.

virtual	~RtLayout ()
	Destructor (does nothing)

virtual RtIterator< T >	iterator ()
	Get iterator.

virtual const std::string	getRealm () const
	Get realm where the solvers are allocated.

virtual void	setRealm (const std::string &a_realm)
	Set realm for solvers.

virtual void	addSolver (RefCountedPtr< T > a_solver)
	Add a new solver to the solver layout.

virtual void	parseOptions ()
	Parse options.

virtual void	parseRuntimeOptions ()
	Parse runtime options.

virtual void	allocate ()
	Allocate internal storage for solvers.

virtual void	preRegrid (const int a_base, const int a_oldFinestLevel)
	Pre regrid stuff.

virtual void	deallocate ()
	Deallocate internal storage for solvers.

virtual void	regrid (const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel)
	Regrid all solvers.

virtual void	registerOperators ()
	Register operators.

virtual void	setAmr (const RefCountedPtr< AmrMesh > &a_amr)
	Set amr.

virtual void	setComputationalGeometry (const RefCountedPtr< ComputationalGeometry > &a_computationalGeometry)
	Set the computational geometry.

virtual void	sanityCheck ()
	Do a sanity check.

virtual void	setPhase (phase::which_phase a_phase=phase::gas)
	Set phase.

virtual void	setVerbosity (const int a_verbosity)
	Set verbosity.

virtual void	setTime (const int a_step, const Real a_time, const Real a_dt)
	Set time.

virtual void	setSource (const EBAMRCellData &a_source)
	Convenience function. Set source terms for all species. Mostly used for debugging.

virtual void	setSource (const Real a_source)
	Convenience function. Set constant source terms for all species. Mostly used for debugging.

virtual void	setStationary (const bool a_stationary)
	Turn on/off stationary.

virtual void	writePlotFile ()
	Convenience function. All solvers write plot files.

virtual void	advance (const Real a_dt)
	Convenience function. Call advance method for each solver.

virtual void	initialData ()
	Fill with initial data.

virtual bool	isStationary ()
	Check if solvers are stationary.

virtual phase::which_phase	getPhase ()
	Get phase.

virtual Vector< RefCountedPtr< T > > &	getSolvers ()
	Get solvers.

virtual Vector< RefCountedPtr< RtSpecies > > &	getSpecies ()
	Get species.

virtual Vector< EBAMRCellData * >	getSources ()
	Get all source terms.

virtual Vector< EBAMRCellData * >	getPhis ()
	Get all states.

Protected Attributes
std::string	m_realm
	Realm.

phase::which_phase	m_phase
	Phase.

Vector< RefCountedPtr< T > >	m_solvers
	Solvers.

Vector< RefCountedPtr< RtSpecies > >	m_species
	Species.

int	m_verbosity
	Verbosity.

Detailed Description

template<class T>
class RtLayout< T >

Class for holding a set of RtSolvers. T must derive from RtSolver.

Constructor & Destructor Documentation

◆ RtLayout()

template<class T >

RtLayout< T >::RtLayout ( const Vector< RefCountedPtr< RtSpecies > > & a_RtSpecies )

Full constructor.

Parameters

[in] a_RtSpecies List of RTE species.

Member Function Documentation

◆ addSolver()

template<class T >

void RtLayout< T >::addSolver ( RefCountedPtr< T > a_solver )

virtual

Add a new solver to the solver layout.

Parameters

[in] a_solver New RTE solver.

◆ advance()

template<class T >

void RtLayout< T >::advance ( const Real a_dt )

virtual

Convenience function. Call advance method for each solver.

Parameters

[in] a_dt Advance method.

◆ getPhase()

template<class T >

phase::which_phase RtLayout< T >::getPhase ( )

virtual

Get phase.

Returns: Phase

◆ getPhis()

template<class T >

Vector< EBAMRCellData * > RtLayout< T >::getPhis ( )

virtual

Get all states.

Returns: Phis

◆ getRealm()

template<class T >

const std::string RtLayout< T >::getRealm ( ) const

virtual

Get realm where the solvers are allocated.

Returns: Realm

◆ getSolvers()

template<class T >

Vector< RefCountedPtr< T > > & RtLayout< T >::getSolvers ( )

virtual

Get solvers.

Returns: Solvers

◆ getSources()

template<class T >

Vector< EBAMRCellData * > RtLayout< T >::getSources ( )

virtual

Get all source terms.

Returns: Sources

◆ getSpecies()

template<class T >

Vector< RefCountedPtr< RtSpecies > > & RtLayout< T >::getSpecies ( )

virtual

Get species.

Returns: Species

◆ initialData()

template<class T >

void RtLayout< T >::initialData ( )

virtual

Fill with initial data.

Only relevant for transient solvers

◆ isStationary()

template<class T >

bool RtLayout< T >::isStationary ( )

virtual

Check if solvers are stationary.

Returns: True if stationary, false otherwise

◆ iterator()

template<class T >

RtIterator< T > RtLayout< T >::iterator ( )

virtual

Get iterator.

Returns: Returns a new iterator for iterating through the RTE solvers.

◆ preRegrid()

template<class T >

void RtLayout< T >::preRegrid	(	const int	a_base,
		const int	a_oldFinestLevel
	)

virtual

Pre regrid stuff.

Parameters

[in]	a_base	Coarsest level which changes.
[in]	a_oldFinestLevel	Finest AMR level before regrid.

◆ regrid()

template<class T >

void RtLayout< T >::regrid	(	const int	a_lmin,
		const int	a_oldFinestLevel,
		const int	a_newFinestLevel
	)

virtual

Regrid all solvers.

Parameters

[in]	a_lmin	Coarsest level where grids did not change.
[in]	a_oldFinestLevel	Finest AMR level before the regrid.
[in]	a_newFinestLevel	Finest AMR level after the regrid.

◆ setAmr()

template<class T >

void RtLayout< T >::setAmr ( const RefCountedPtr< AmrMesh > & a_amr )

virtual

Set amr.

Parameters

[in] a_amr AmrMesh object.

◆ setComputationalGeometry()

template<class T >

void RtLayout< T >::setComputationalGeometry ( const RefCountedPtr< ComputationalGeometry > & a_computationalGeometry )

virtual

Set the computational geometry.

Parameters

[in] a_computationalGeometry Computational geometry.

◆ setPhase()

template<class T >

void RtLayout< T >::setPhase ( phase::which_phase a_phase = phase::gas )

virtual

Set phase.

This must be done BEFORE callilng setComputationalGeometry

Parameters

[in] a_phase Phase

◆ setRealm()

template<class T >

void RtLayout< T >::setRealm ( const std::string & a_realm )

virtual

Set realm for solvers.

Parameters

[in] a_realm Realm name

◆ setSource() [1/2]

template<class T >

void RtLayout< T >::setSource ( const EBAMRCellData & a_source )

virtual

Convenience function. Set source terms for all species. Mostly used for debugging.

Parameters

[in] a_source Source term. Copied into every solver's source term.

◆ setSource() [2/2]

template<class T >

void RtLayout< T >::setSource ( const Real a_source )

virtual

Convenience function. Set constant source terms for all species. Mostly used for debugging.

Parameters

[in] a_source Source term set on every solver.

◆ setStationary()

template<class T >

void RtLayout< T >::setStationary ( const bool a_stationary )

virtual

Turn on/off stationary.

Parameters

[in] a_stationary If true, every RTE solver will be set to stationary.

◆ setTime()

template<class T >

void RtLayout< T >::setTime	(	const int	a_step,
		const Real	a_time,
		const Real	a_dt
	)

virtual

Set time.

Parameters

[in]	a_step	Time step number
[in]	a_time	Time (in seconds)
[in]	a_dt	Time step increment

Note: This sets m_step=a_step, m_time=a_time, m_dt=a_dt for all solvers.

◆ setVerbosity()

template<class T >

void RtLayout< T >::setVerbosity ( const int a_verbosity )

virtual

Set verbosity.

Parameters

[in] a_verbosity Verbosity level for solvers.

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

Source/RadiativeTransfer/CD_RtLayout.H
Source/RadiativeTransfer/CD_RtLayoutImplem.H

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RtLayout()

Member Function Documentation

◆ addSolver()

◆ advance()

◆ getPhase()

◆ getPhis()

◆ getRealm()

◆ getSolvers()

◆ getSources()

◆ getSpecies()

◆ initialData()

◆ isStationary()

◆ iterator()

◆ preRegrid()

◆ regrid()

◆ setAmr()

◆ setComputationalGeometry()

◆ setPhase()

◆ setRealm()

◆ setSource() [1/2]

◆ setSource() [2/2]

◆ setStationary()

◆ setTime()

◆ setVerbosity()