Block-Structured AMR Software Framework
Public Member Functions | List of all members
amrex::LevelBld Class Referenceabstract

Builds problem-specific AmrLevels. More...

#include <AMReX_LevelBld.H>

Public Member Functions

virtual ~LevelBld ()=default
 
 LevelBld () noexcept=default
 
 LevelBld (LevelBld const &)=default
 
 LevelBld (LevelBld &&) noexcept=default
 
LevelBld & operator= (LevelBld const &)=default
 
LevelBld & operator= (LevelBld &&) noexcept=default
 
virtual void variableSetUp ()=0
 Perform any problem-dependent setup such as physical boundary condition and derived quantities. This is a pure virtual function and hence MUST be implemented by derived classes. More...
 
virtual void variableSetUpForNewCompProcs ()
 
virtual void variableCleanUp ()=0
 Perform any problem-dependent cleanup. This is a pure virtual function and hence MUST be implemented by derived classes. More...
 
virtual AmrLevel * operator() ()=0
 This is a virtual constructor for types derived from AmrLevel. The derived type is initialized with the default constructor. This is a pure virtual function and hence MUST be implemented by derived classes. More...
 
virtual AmrLevel * operator() (Amr &papa, int lev, const Geometry &geom_lev, const BoxArray &ba, const DistributionMapping &dm, Real time)=0
 This is a virtual constructor for types derived from AmrLevel. The derived type is initialized with the five specified variables. This is a pure virtual function and hence MUST be implemented by derived classes. More...
 

Detailed Description

Builds problem-specific AmrLevels.

Abstract base class specifying an interface for building problem-specific AmrLevels.

Constructor & Destructor Documentation

◆ ~LevelBld()

virtual amrex::LevelBld::~LevelBld ( )
virtualdefault

◆ LevelBld() [1/3]

amrex::LevelBld::LevelBld ( )
defaultnoexcept

◆ LevelBld() [2/3]

amrex::LevelBld::LevelBld ( LevelBld const &  )
default

◆ LevelBld() [3/3]

amrex::LevelBld::LevelBld ( LevelBld &&  )
defaultnoexcept

Member Function Documentation

◆ operator()() [1/2]

virtual AmrLevel* amrex::LevelBld::operator() ( )
pure virtual

This is a virtual constructor for types derived from AmrLevel. The derived type is initialized with the default constructor. This is a pure virtual function and hence MUST be implemented by derived classes.

◆ operator()() [2/2]

virtual AmrLevel* amrex::LevelBld::operator() ( Amr &  papa,
int  lev,
const Geometry &  geom_lev,
const BoxArray &  ba,
const DistributionMapping &  dm,
Real  time 
)
pure virtual

This is a virtual constructor for types derived from AmrLevel. The derived type is initialized with the five specified variables. This is a pure virtual function and hence MUST be implemented by derived classes.

Parameters
papa
lev
geom_lev
ba
dm
time

◆ operator=() [1/2]

LevelBld& amrex::LevelBld::operator= ( LevelBld &&  )
defaultnoexcept

◆ operator=() [2/2]

LevelBld& amrex::LevelBld::operator= ( LevelBld const &  )
default

◆ variableCleanUp()

virtual void amrex::LevelBld::variableCleanUp ( )
pure virtual

Perform any problem-dependent cleanup. This is a pure virtual function and hence MUST be implemented by derived classes.

◆ variableSetUp()

virtual void amrex::LevelBld::variableSetUp ( )
pure virtual

Perform any problem-dependent setup such as physical boundary condition and derived quantities. This is a pure virtual function and hence MUST be implemented by derived classes.

◆ variableSetUpForNewCompProcs()

virtual void amrex::LevelBld::variableSetUpForNewCompProcs ( )
inlinevirtual
The documentation for this class was generated from the following file: