Attributes of StateData. More...

#include <AMReX_StateDescriptor.H>

Classes
class	BndryFunc

Public Types
enum	TimeCenter { Point = 0 , Interval }
	Defines the temporal centeredness of data. More...

Public Member Functions
	StateDescriptor () noexcept
	The default constructor.

	StateDescriptor (IndexType btyp, TimeCenter ttyp, int ident, int nextra, int num_comp, InterpBase *interp, bool extrap=false, bool store_in_checkpoint=true)
	Constructor that sets all data members.

void	define (IndexType btyp, TimeCenter ttyp, int ident, int nextra, int num_comp, InterpBase *interp, bool extrap=false, bool store_in_checkpoint=true)
	Define the data members if constructed with default constructor.

void	setComponent (int comp, const std::string &nm, const BCRec &bc, const BndryFunc &func, InterpBase *interp=nullptr, int max_map_start_comp=-1, int min_map_end_comp=-1)
	Sets details of comp component.

void	setComponent (int comp, const std::string &nm, const BCRec &bc, const BndryFunc &func, InterpBase *interp, bool a_primary, int groupsize)
	Sets details of comp component.

void	resetComponentBCs (int comp, const BCRec &bcr, const BndryFunc &func)
	Resets boundary condition data for comp component.

void	setUpMaps (int &use_default_map, const InterpBase default_map, int start_comp, int num_comp, InterpBase &maps, int &nmaps, int &map_start_comp, int &map_num_comp, int &max_start_comp, int *&min_end_comp) const
	Set interpolaters for a subset of the state vector components.

void	dumpNames (std::ostream &os, int start_comp, int num_comp) const
	Output names of components.

IndexType	getType () const noexcept
	Returns the IndexType.

StateDescriptor::TimeCenter	timeType () const noexcept
	Returns StateDescriptor::TimeCenter.

int	nComp () const noexcept
	Returns number of components.

int	nExtra () const noexcept
	Returns the grow factor.

InterpBase *	interp () const noexcept
	Returns the interpolater.

InterpBase *	interp (int i) const noexcept
	Returns the interpolater of specified component.

const std::string &	name (int i) const noexcept
	Returns the name of specified component.

const BCRec &	getBC (int i) const noexcept
	Returns the BCRec of specified component.

const Vector< BCRec > &	getBCs () const noexcept
	Returns all BCRecs.

const BndryFunc &	bndryFill (int i) const noexcept
	Returns the BndryFunc of specified component.

int	inRange (int sc, int nc) const noexcept
	Is sc>=0 && sc+nc<=ncomp ?

bool	identicalInterps (int scomp, int ncomp) const noexcept
	Are the interpolaters in the specified range identical?

std::vector< std::pair< int, int > >	sameInterps (int scomp, int ncomp) const

bool	extrap () const noexcept
	Can extrapolate in time.

bool	store_in_checkpoint () const noexcept
	Should store this StateData in the checkpoint file.

bool	primary (int i) const noexcept

int	groupsize (int i) const noexcept

bool	RunOnGPU () const noexcept
	will it run on gpu?

bool	hasBndryFuncFab () const noexcept
	has new fab version of BndryFunc?

Static Public Member Functions
static void	cleanUpMaps (InterpBase *&maps, int &map_start_comp, int &map_num_comp, int &max_start_comp, int *&min_end_comp)
	Cleanup interpolaters for a subset of the state vector components.

static void	setBndryFuncThreadSafety (int ext_dir_safe) noexcept

Friends
class	DescriptorList

Detailed Description

Attributes of StateData.

Member Enumeration Documentation

◆ TimeCenter

enum amrex::StateDescriptor::TimeCenter

Defines the temporal centeredness of data.

Enumerator
Point
Interval

Constructor & Destructor Documentation

◆ StateDescriptor() [1/2]

amrex::StateDescriptor::StateDescriptor ( )

inlinenoexcept

The default constructor.

◆ StateDescriptor() [2/2]

amrex::StateDescriptor::StateDescriptor	(	IndexType	btyp,
		StateDescriptor::TimeCenter	ttyp,
		int	ident,
		int	nextra,
		int	num_comp,
		InterpBase *	interp,
		bool	extrap = `false`,
		bool	store_in_checkpoint = `true`
	)

Constructor that sets all data members.

Parameters

btyp
ttyp
ident
nextra
num_comp
interp
extrap
store_in_checkpoint

Member Function Documentation

◆ bndryFill()

const StateDescriptor::BndryFunc & amrex::StateDescriptor::bndryFill ( int i ) const

noexcept

Returns the BndryFunc of specified component.

Parameters

i

◆ cleanUpMaps()

void amrex::StateDescriptor::cleanUpMaps	(	InterpBase **&	maps,
		int *&	map_start_comp,
		int *&	map_num_comp,
		int *&	max_start_comp,
		int *&	min_end_comp
	)

static

Cleanup interpolaters for a subset of the state vector components.

Parameters

maps
map_start_comp
map_num_comp
max_start_comp
min_end_comp

◆ define()

void amrex::StateDescriptor::define	(	IndexType	btyp,
		StateDescriptor::TimeCenter	ttyp,
		int	ident,
		int	nextra,
		int	num_comp,
		InterpBase *	interp,
		bool	extrap = `false`,
		bool	store_in_checkpoint = `true`
	)

Define the data members if constructed with default constructor.

Parameters

btyp
ttyp
ident
nextra
num_comp
interp
extrap
store_in_checkpoint

◆ dumpNames()

void amrex::StateDescriptor::dumpNames	(	std::ostream &	os,
		int	start_comp,
		int	num_comp
	)		const

Output names of components.

Parameters

os
start_comp
num_comp

◆ extrap()

bool amrex::StateDescriptor::extrap ( ) const

noexcept

Can extrapolate in time.

◆ getBC()

const BCRec & amrex::StateDescriptor::getBC ( int i ) const

noexcept

Returns the BCRec of specified component.

Parameters

i

◆ getBCs()

const Vector< BCRec > & amrex::StateDescriptor::getBCs ( ) const

noexcept

Returns all BCRecs.

◆ getType()

IndexType amrex::StateDescriptor::getType ( ) const

noexcept

Returns the IndexType.

◆ groupsize()

int amrex::StateDescriptor::groupsize ( int i ) const

inlinenoexcept

◆ hasBndryFuncFab()

bool amrex::StateDescriptor::hasBndryFuncFab ( ) const

inlinenoexcept

has new fab version of BndryFunc?

◆ identicalInterps()

bool amrex::StateDescriptor::identicalInterps	(	int	scomp,
		int	ncomp
	)		const

noexcept

Are the interpolaters in the specified range identical?

Parameters

scomp
ncomp

◆ inRange()

int amrex::StateDescriptor::inRange	(	int	sc,
		int	nc
	)		const

noexcept

Is sc>=0 && sc+nc<=ncomp ?

Parameters

sc
nc

◆ interp() [1/2]

InterpBase * amrex::StateDescriptor::interp ( ) const

noexcept

Returns the interpolater.

◆ interp() [2/2]

InterpBase * amrex::StateDescriptor::interp ( int i ) const

noexcept

Returns the interpolater of specified component.

Parameters

i

◆ name()

const std::string & amrex::StateDescriptor::name ( int i ) const

noexcept

Returns the name of specified component.

Parameters

i

◆ nComp()

int amrex::StateDescriptor::nComp ( ) const

noexcept

Returns number of components.

◆ nExtra()

int amrex::StateDescriptor::nExtra ( ) const

noexcept

Returns the grow factor.

◆ primary()

bool amrex::StateDescriptor::primary ( int i ) const

inlinenoexcept

◆ resetComponentBCs()

void amrex::StateDescriptor::resetComponentBCs	(	int	comp,
		const BCRec &	bcr,
		const BndryFunc &	func
	)

Resets boundary condition data for comp component.

Parameters

comp
bcr
func

◆ RunOnGPU()

bool amrex::StateDescriptor::RunOnGPU ( ) const

inlinenoexcept

will it run on gpu?

◆ sameInterps()

std::vector< std::pair< int, int > > amrex::StateDescriptor::sameInterps	(	int	scomp,
		int	ncomp
	)		const

◆ setBndryFuncThreadSafety()

static void amrex::StateDescriptor::setBndryFuncThreadSafety ( int ext_dir_safe )

inlinestaticnoexcept

◆ setComponent() [1/2]

void amrex::StateDescriptor::setComponent	(	int	comp,
		const std::string &	nm,
		const BCRec &	bc,
		const BndryFunc &	func,
		InterpBase *	interp,
		bool	a_primary,
		int	groupsize
	)

Sets details of comp component.

Parameters

comp
nm
bc
func
interp
a_primary
groupsize

◆ setComponent() [2/2]

void amrex::StateDescriptor::setComponent	(	int	comp,
		const std::string &	nm,
		const BCRec &	bc,
		const BndryFunc &	func,
		InterpBase *	interp = `nullptr`,
		int	max_map_start_comp = `-1`,
		int	min_map_end_comp = `-1`
	)

Sets details of comp component.

Parameters

comp
nm
bc
func
interp
max_map_start_comp
min_map_end_comp

◆ setUpMaps()

void amrex::StateDescriptor::setUpMaps	(	int &	use_default_map,
		const InterpBase *	default_map,
		int	start_comp,
		int	num_comp,
		InterpBase **&	maps,
		int &	nmaps,
		int *&	map_start_comp,
		int *&	map_num_comp,
		int *&	max_start_comp,
		int *&	min_end_comp
	)		const

Set interpolaters for a subset of the state vector components.

Parameters

use_default_map
default_map
start_comp
num_comp
maps
nmaps
map_start_comp
map_num_comp
max_start_comp
min_end_comp

◆ store_in_checkpoint()

bool amrex::StateDescriptor::store_in_checkpoint ( ) const

noexcept

Should store this StateData in the checkpoint file.

◆ timeType()

StateDescriptor::TimeCenter amrex::StateDescriptor::timeType ( ) const

noexcept

Returns StateDescriptor::TimeCenter.

Friends And Related Symbol Documentation

◆ DescriptorList

friend class DescriptorList

friend

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

/home/runner/work/amrex/amrex/Src/Amr/AMReX_StateDescriptor.H
/home/runner/work/amrex/amrex/Src/Amr/AMReX_StateDescriptor.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ TimeCenter

Constructor & Destructor Documentation

◆ StateDescriptor() [1/2]

◆ StateDescriptor() [2/2]

Member Function Documentation

◆ bndryFill()

◆ cleanUpMaps()

◆ define()

◆ dumpNames()

◆ extrap()

◆ getBC()

◆ getBCs()

◆ getType()

◆ groupsize()

◆ hasBndryFuncFab()

◆ identicalInterps()

◆ inRange()

◆ interp() [1/2]

◆ interp() [2/2]

◆ name()

◆ nComp()

◆ nExtra()

◆ primary()

◆ resetComponentBCs()

◆ RunOnGPU()

◆ sameInterps()

◆ setBndryFuncThreadSafety()

◆ setComponent() [1/2]

◆ setComponent() [2/2]

◆ setUpMaps()

◆ store_in_checkpoint()

◆ timeType()

Friends And Related Symbol Documentation

◆ DescriptorList