Block-Structured AMR Software Framework
Public Member Functions | Private Attributes | List of all members
amrex::DeriveList Class Reference

A list of DeriveRecs. More...

#include <AMReX_Derive.H>

Public Member Functions

 DeriveList ()=default
 The default constructor. More...
 
 ~DeriveList ()=default
 
 DeriveList (const DeriveList &)=delete
 
 DeriveList (DeriveList &&)=delete
 
DeriveList & operator= (const DeriveList &)=delete
 
DeriveList & operator= (DeriveList &&)=delete
 
bool canDerive (const std::string &name) const
 Determines whether quantity identified by <name> is in the registry. More...
 
const DeriveRec * get (const std::string &name) const
 Access the particular record in registry. More...
 
void add (const std::string &name, IndexType result_type, int nvar_derive, DeriveFunc der_func, const DeriveRec::DeriveBoxMap &bx_map, Interpolater *interp=&pc_interp)
 Adds another entry to the registry. More...
 
void add (const std::string &name, IndexType result_type, int nvar_derive, DeriveFunc3D der_func_3d, const DeriveRec::DeriveBoxMap &bx_map, Interpolater *interp=&pc_interp)
 
void add (const std::string &name, IndexType result_type, int nvar_derive, const DeriveFuncFab &der_func_fab, const DeriveRec::DeriveBoxMap &bx_map, Interpolater *interp=&pc_interp)
 
void add (const std::string &name, IndexType result_type, int nvar_derive, const DeriveFuncMF &der_func_mf, const DeriveRec::DeriveBoxMap &bx_map, Interpolater *interp=&pc_interp)
 
void add (const std::string &name, IndexType result_type, int nvar_derive, const DeriveRec::DeriveBoxMap &box_map=&DeriveRec::TheSameBox)
 This version doesn't take a Fortran function. More...
 
void add (const std::string &name, IndexType res_typ, int nvar_derive, Vector< std::string > const &vars, DeriveFunc der_func, const DeriveRec::DeriveBoxMap &bx_map, Interpolater *interp=&pc_interp)
 Adds another entry to the registry. More...
 
void add (const std::string &name, IndexType res_typ, int nvar_derive, Vector< std::string > const &vars, DeriveFunc3D der_func_3d, const DeriveRec::DeriveBoxMap &bx_map, Interpolater *interp=&pc_interp)
 
void add (const std::string &name, IndexType res_typ, int nvar_derive, Vector< std::string > const &vars, const DeriveFuncFab &der_func_fab, const DeriveRec::DeriveBoxMap &bx_map, Interpolater *interp=&pc_interp)
 
void add (const std::string &name, IndexType res_typ, int nvar_derive, Vector< std::string > const &vars, const DeriveFuncMF &der_func_mf, const DeriveRec::DeriveBoxMap &bx_map, Interpolater *interp=&pc_interp)
 
void addComponent (const std::string &name, const DescriptorList &d_list, int state_indx, int s_comp, int n_comp)
 Adds another StateRange to the DeriveRec identified by <name>. More...
 
std::list< DeriveRec > & dlist ()
 
void clear ()
 

Private Attributes

std::list< DeriveRec > lst
 

Detailed Description

A list of DeriveRecs.

DeriveList manages and provides access to the list of DeriveRecs.

Constructor & Destructor Documentation

◆ DeriveList() [1/3]

amrex::DeriveList::DeriveList ( )
default

The default constructor.

◆ ~DeriveList()

amrex::DeriveList::~DeriveList ( )
default

◆ DeriveList() [2/3]

amrex::DeriveList::DeriveList ( const DeriveList &  )
delete

◆ DeriveList() [3/3]

amrex::DeriveList::DeriveList ( DeriveList &&  )
delete

Member Function Documentation

◆ add() [1/9]

void amrex::DeriveList::add ( const std::string &  name,
IndexType  res_typ,
int  nvar_derive,
Vector< std::string > const &  vars,
const DeriveFuncFab &  der_func_fab,
const DeriveRec::DeriveBoxMap &  bx_map,
Interpolater *  interp = &pc_interp 
)

◆ add() [2/9]

void amrex::DeriveList::add ( const std::string &  name,
IndexType  res_typ,
int  nvar_derive,
Vector< std::string > const &  vars,
const DeriveFuncMF &  der_func_mf,
const DeriveRec::DeriveBoxMap &  bx_map,
Interpolater *  interp = &pc_interp 
)

◆ add() [3/9]

void amrex::DeriveList::add ( const std::string &  name,
IndexType  res_typ,
int  nvar_derive,
Vector< std::string > const &  vars,
DeriveFunc  der_func,
const DeriveRec::DeriveBoxMap &  bx_map,
Interpolater *  interp = &pc_interp 
)

Adds another entry to the registry.

Parameters
name
result_type
nvar_derive
var_names
der_func
box_map
interp

◆ add() [4/9]

void amrex::DeriveList::add ( const std::string &  name,
IndexType  res_typ,
int  nvar_derive,
Vector< std::string > const &  vars,
DeriveFunc3D  der_func_3d,
const DeriveRec::DeriveBoxMap &  bx_map,
Interpolater *  interp = &pc_interp 
)

◆ add() [5/9]

void amrex::DeriveList::add ( const std::string &  name,
IndexType  result_type,
int  nvar_derive,
const DeriveFuncFab &  der_func_fab,
const DeriveRec::DeriveBoxMap &  bx_map,
Interpolater *  interp = &pc_interp 
)

◆ add() [6/9]

void amrex::DeriveList::add ( const std::string &  name,
IndexType  result_type,
int  nvar_derive,
const DeriveFuncMF &  der_func_mf,
const DeriveRec::DeriveBoxMap &  bx_map,
Interpolater *  interp = &pc_interp 
)

◆ add() [7/9]

void amrex::DeriveList::add ( const std::string &  name,
IndexType  result_type,
int  nvar_derive,
const DeriveRec::DeriveBoxMap &  box_map = &DeriveRec::TheSameBox 
)

This version doesn't take a Fortran function.

Parameters
name
result_type
nvar_derive
box_map

◆ add() [8/9]

void amrex::DeriveList::add ( const std::string &  name,
IndexType  result_type,
int  nvar_derive,
DeriveFunc  der_func,
const DeriveRec::DeriveBoxMap &  bx_map,
Interpolater *  interp = &pc_interp 
)

Adds another entry to the registry.

Parameters
name
result_type
nvar_derive
der_func
box_map
interp

◆ add() [9/9]

void amrex::DeriveList::add ( const std::string &  name,
IndexType  result_type,
int  nvar_derive,
DeriveFunc3D  der_func_3d,
const DeriveRec::DeriveBoxMap &  bx_map,
Interpolater *  interp = &pc_interp 
)

◆ addComponent()

void amrex::DeriveList::addComponent ( const std::string &  name,
const DescriptorList &  d_list,
int  state_indx,
int  s_comp,
int  n_comp 
)

Adds another StateRange to the DeriveRec identified by <name>.

Parameters
name
d_list
state_indx
start_comp
ncomp

◆ canDerive()

bool amrex::DeriveList::canDerive ( const std::string &  name) const

Determines whether quantity identified by <name> is in the registry.

Parameters
name

◆ clear()

void amrex::DeriveList::clear ( )
inline

◆ dlist()

std::list< DeriveRec > & amrex::DeriveList::dlist ( )

◆ get()

const DeriveRec * amrex::DeriveList::get ( const std::string &  name) const

Access the particular record in registry.

Parameters
name

◆ operator=() [1/2]

DeriveList& amrex::DeriveList::operator= ( const DeriveList &  )
delete

◆ operator=() [2/2]

DeriveList& amrex::DeriveList::operator= ( DeriveList &&  )
delete

Member Data Documentation

◆ lst

std::list<DeriveRec> amrex::DeriveList::lst
private
The documentation for this class was generated from the following files: