amrex::DescriptorList Class Reference

#include <AMReX_StateDescriptor.H>

Public Member Functions
void	clear ()
	Set the list to its default state. More...
int	size () const noexcept
	Returns number of elements in the list. More...
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 new StateDescriptor at index indx to list. More...
void	resetComponentBCs (int indx, int comp, const BCRec &bc, const StateDescriptor::BndryFunc &func)
	Calls resetComponentBCs() on StateDescriptor at index indx. More...
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)
	Calls setComponent() on StateDescriptor at index indx. More...
void	setComponent (int indx, int comp, const Vector< std::string > &nm, const Vector< BCRec > &bc, const StateDescriptor::BndryFunc &func, InterpBase *interp=nullptr)
	Calls setComponent() on StateDescriptor at index indx on group. More...
const StateDescriptor &	operator[] (int k) const noexcept

Private Attributes
Vector< std::unique_ptr< StateDescriptor > >	desc

Detailed Description

A List of StateDescriptors.

A container class for StateDescriptors.

Member Function Documentation

addDescriptor()

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 new StateDescriptor at index indx to list.

Parameters

indx
typ
ttyp
nextra
num_comp
interp
extrap
store_in_checkpoint

clear()

void amrex::DescriptorList::clear

(

)

Set the list to its default state.

operator[]()

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

noexcept

Returns StateDescriptor at index k.

resetComponentBCs()

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

Calls resetComponentBCs() on StateDescriptor at index indx.

Parameters

indx
comp
bc
func

setComponent() [1/2]

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
	)

Calls setComponent() on StateDescriptor at index indx.

Parameters

indx
comp
nm
bc
func
interp
max_map_start_comp
min_map_end_comp

setComponent() [2/2]

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

Calls setComponent() on StateDescriptor at index indx on group.

Parameters

indx
comp
nm
bc
func
interp

size()

int amrex::DescriptorList::size ( ) const

noexcept

Returns number of elements in the list.

Member Data Documentation

desc

Vector<std::unique_ptr<StateDescriptor> > amrex::DescriptorList::desc

private

---

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