Public Member Functions
void	clear ()
	Remove all descriptors and reset the list to an empty state.

int	size () const noexcept
	Returns number of descriptors currently stored.

void	addDescriptor (int indx, IndexType typ, StateDescriptor::TimeCenter ttyp, int nextra, int num_comp, InterpBase *interp, bool extrap=false, bool store_in_checkpoint=true)
	Adds a new StateDescriptor at index `indx`.

void	resetComponentBCs (int indx, int comp, const BCRec &bc, const StateDescriptor::BndryFunc &func)
	Forward resetComponentBCs() to descriptor `indx`.

void	setComponent (int indx, int comp, const std::string &nm, const BCRec &bc, const StateDescriptor::BndryFunc &func, InterpBase *interp=nullptr, int max_map_start_comp=-1, int min_map_end_comp=-1)
	Forward the basic setComponent() overload to descriptor `indx`.

void	setComponent (int indx, int comp, const Vector< std::string > &nm, const Vector< BCRec > &bc, const StateDescriptor::BndryFunc &func, InterpBase *interp=nullptr)
	Batch set multiple grouped components on descriptor `indx`.

const StateDescriptor &	operator[] (int k) const noexcept
	Returns StateDescriptor stored at index `k`.

Detailed Description

A List of StateDescriptors.

A container class for StateDescriptors.

Member Function Documentation

void amrex::DescriptorList::addDescriptor	(	int	indx,
		IndexType	typ,
		StateDescriptor::TimeCenter	ttyp,
		int	nextra,
		int	num_comp,
		InterpBase *	interp,
		bool	extrap = `false`,
		bool	store_in_checkpoint = `true`
	)

Adds a new StateDescriptor at index indx.

Parameters

indx	Slot within the descriptor list (usually StateData index).
typ	Index type (cell/nodal).
ttyp	Time-centering (Point or Interval).
nextra	Number of ghost cells.
num_comp	Number of components stored.
interp	Default interpolater between levels.
extrap	Whether to allow time extrapolation.
store_in_checkpoint	Whether to persist this descriptor in checkpoints.

void amrex::DescriptorList::clear ( )

Remove all descriptors and reset the list to an empty state.

const StateDescriptor & amrex::DescriptorList::operator[] ( int k ) const

noexcept

Returns StateDescriptor stored at index k.

void amrex::DescriptorList::resetComponentBCs	(	int	indx,
		int	comp,
		const BCRec &	bc,
		const StateDescriptor::BndryFunc &	func
	)

Forward resetComponentBCs() to descriptor indx.

Parameters

indx	Descriptor index into the list.
comp	Component to update.
bc	Replacement BCRec.
func	Replacement physical BC functor.

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

Forward the basic setComponent() overload to descriptor indx.

Parameters

indx	Descriptor index.
comp	Component to configure.
nm	Component name.
bc	Boundary condition recipe.
func	Physical BC functor.
interp	Optional per-component interpolater override.
max_map_start_comp	Optional coupling bound (see StateDescriptor::setComponent()).
min_map_end_comp	Optional coupling bound.

void amrex::DescriptorList::setComponent	(	int	indx,
		int	comp,
		const Vector< std::string > &	nm,
		const Vector< BCRec > &	bc,
		const StateDescriptor::BndryFunc &	func,
		InterpBase *	interp = `nullptr`
	)

Batch set multiple grouped components on descriptor indx.

Parameters

indx	Descriptor index.
comp	Starting component index for the group.
nm	Names assigned to each group entry.
bc	Boundary condition records per entry.
func	Physical BC functor shared across entries.
interp	Optional interpolater override applied to every component in the group.

int amrex::DescriptorList::size ( ) const

noexcept

Returns number of descriptors currently stored.

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