Class AdvDiffHierarchyIntegrator provides an abstract interface for a time integrator for advection-diffusion or advection-reaction-diffusion equations on an AMR grid hierarchy, along with basic data management for variables defined on that hierarchy.
#include <ibamr/AdvDiffHierarchyIntegrator.h>
Public Types | |
| using | ResetPropertiesFcnPtr = void(*)(int property_idx, SAMRAI::tbox::Pointer< IBTK::HierarchyMathOps > hier_math_ops, int integrator_step, double time, bool initial_time, bool regrid_time, void *ctx) |
| Function to reset variables registered by this integrator. More... | |
| using | PreprocessIntegrateHierarchyCallbackFcnPtr = void(*)(double current_time, double new_time, int num_cycles, void *ctx) |
| using | IntegrateHierarchyCallbackFcnPtr = void(*)(double current_time, double new_time, int cycle_num, void *ctx) |
| using | PostprocessIntegrateHierarchyCallbackFcnPtr = void(*)(double current_time, double new_time, bool skip_synchronize_new_state_data, int num_cycles, void *ctx) |
| using | ApplyGradientDetectorCallbackFcnPtr = void(*)(SAMRAI::tbox::Pointer< SAMRAI::hier::BasePatchHierarchy< NDIM > > hierarchy, int level_number, double error_data_time, int tag_index, bool initial_time, bool uses_richardson_extrapolation_too, void *ctx) |
| using | RegridHierarchyCallbackFcnPtr = void(*)(SAMRAI::tbox::Pointer< SAMRAI::hier::BasePatchHierarchy< NDIM > > hierarchy, double data_time, bool initial_time, void *ctx) |
Static Protected Attributes | |
| static const std::string | SYNCH_CURRENT_DATA_ALG |
| static const std::string | SYNCH_NEW_DATA_ALG |
Private Types | |
| using | RefineAlgorithmMap = std::map< std::string, SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineAlgorithm< NDIM > > > |
| using | RefinePatchStrategyMap = std::map< std::string, std::unique_ptr< SAMRAI::xfer::RefinePatchStrategy< NDIM > > > |
| using | RefineScheduleMap = std::map< std::string, std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > > |
| using | CoarsenAlgorithmMap = std::map< std::string, SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenAlgorithm< NDIM > > > |
| using | CoarsenPatchStrategyMap = std::map< std::string, std::unique_ptr< SAMRAI::xfer::CoarsenPatchStrategy< NDIM > > > |
| using | CoarsenScheduleMap = std::map< std::string, std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenSchedule< NDIM > > > > |
Private Member Functions | |
| AdvDiffHierarchyIntegrator ()=delete | |
| Default constructor. More... | |
| AdvDiffHierarchyIntegrator (const AdvDiffHierarchyIntegrator &from)=delete | |
| Copy constructor. More... | |
| AdvDiffHierarchyIntegrator & | operator= (const AdvDiffHierarchyIntegrator &that)=delete |
| Assignment operator. More... | |
| void | getFromInput (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db, bool is_from_restart) |
| void | getFromRestart () |
Member Typedef Documentation
◆ ResetPropertiesFcnPtr
| using IBAMR::AdvDiffHierarchyIntegrator::ResetPropertiesFcnPtr = void (*)(int property_idx, SAMRAI::tbox::Pointer<IBTK::HierarchyMathOps> hier_math_ops, int integrator_step, double time, bool initial_time, bool regrid_time, void* ctx) |
◆ PreprocessIntegrateHierarchyCallbackFcnPtr
|
inherited |
Callback function specification to enable further specialization of preprocessIntegrateHierarchy().
◆ IntegrateHierarchyCallbackFcnPtr
|
inherited |
Callback function specification to enable further specialization of integrateHierarchy().
◆ PostprocessIntegrateHierarchyCallbackFcnPtr
|
inherited |
Callback function specification to enable further specialization of postprocessIntegrateHierarchy().
◆ ApplyGradientDetectorCallbackFcnPtr
|
inherited |
Callback function specification to enable further specialization of applyGradientDetector().
◆ RegridHierarchyCallbackFcnPtr
|
inherited |
Callback function specification to enable further specialization of regridHierarchy().
◆ RefineAlgorithmMap
|
privateinherited |
◆ RefinePatchStrategyMap
|
privateinherited |
◆ RefineScheduleMap
|
privateinherited |
◆ CoarsenAlgorithmMap
|
privateinherited |
◆ CoarsenPatchStrategyMap
|
privateinherited |
◆ CoarsenScheduleMap
|
privateinherited |
Constructor & Destructor Documentation
◆ ~AdvDiffHierarchyIntegrator()
| IBAMR::AdvDiffHierarchyIntegrator::~AdvDiffHierarchyIntegrator | ( | ) |
The destructor for class AdvDiffHierarchyIntegrator unregisters the integrator object with the restart manager when the object is so registered.
◆ AdvDiffHierarchyIntegrator() [1/3]
|
protected |
The constructor for class AdvDiffHierarchyIntegrator sets some default values, reads in configuration information from input and restart databases, and registers the integrator object with the restart manager when requested.
◆ AdvDiffHierarchyIntegrator() [2/3]
|
privatedelete |
- Note
- This constructor is not implemented and should not be used.
◆ AdvDiffHierarchyIntegrator() [3/3]
|
privatedelete |
- Note
- This constructor is not implemented and should not be used.
- Parameters
-
from The value to copy to this object.
Member Function Documentation
◆ setDefaultDiffusionTimeSteppingType()
| void IBAMR::AdvDiffHierarchyIntegrator::setDefaultDiffusionTimeSteppingType | ( | TimeSteppingType | default_diffusion_time_stepping_type | ) |
Set the default diffusion time stepping method to use with registered quantities.
◆ getDefaultDiffusionTimeSteppingType()
| TimeSteppingType IBAMR::AdvDiffHierarchyIntegrator::getDefaultDiffusionTimeSteppingType | ( | ) | const |
Get the default diffusion time stepping method being used with registered quantities.
◆ setDefaultConvectiveDifferencingType()
| void IBAMR::AdvDiffHierarchyIntegrator::setDefaultConvectiveDifferencingType | ( | ConvectiveDifferencingType | default_convective_difference_form | ) |
Set the default convective differencing form to use with registered quantities.
◆ getDefaultConvectiveDifferencingType()
| ConvectiveDifferencingType IBAMR::AdvDiffHierarchyIntegrator::getDefaultConvectiveDifferencingType | ( | ) | const |
Get the default convective differencing form being used with registered quantities.
◆ registerAdvectionVelocity()
|
virtual |
Register a face-centered advection velocity to be used to advect cell-centered quantities by the hierarchy integrator.
Data management for the registered advection velocity will be handled by the hierarchy integrator.
If a function is not provided, it is the responsibility of the user to ensure that the current and new contexts are set correctly.
- Note
- By default, each registered advection velocity is assumed to be divergence free.
◆ setAdvectionVelocityIsDivergenceFree()
| void IBAMR::AdvDiffHierarchyIntegrator::setAdvectionVelocityIsDivergenceFree | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::FaceVariable< NDIM, double > > | u_var, |
| bool | is_div_free | ||
| ) |
Indicate whether a particular advection velocity is discretely divergence free.
◆ getAdvectionVelocityIsDivergenceFree()
| bool IBAMR::AdvDiffHierarchyIntegrator::getAdvectionVelocityIsDivergenceFree | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::FaceVariable< NDIM, double > > | u_var | ) | const |
Determine whether a particular advection velocity has been indicated to be discretely divergence free.
◆ setAdvectionVelocityFunction()
| void IBAMR::AdvDiffHierarchyIntegrator::setAdvectionVelocityFunction | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::FaceVariable< NDIM, double > > | u_var, |
| SAMRAI::tbox::Pointer< IBTK::CartGridFunction > | u_fcn | ||
| ) |
Supply an IBTK::CartGridFunction object to specify the value of a particular advection velocity.
If a function is not provided, it is the responsibility of the user to ensure that the current and new contexts are set correctly.
◆ getAdvectionVelocityFunction()
| SAMRAI::tbox::Pointer<IBTK::CartGridFunction> IBAMR::AdvDiffHierarchyIntegrator::getAdvectionVelocityFunction | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::FaceVariable< NDIM, double > > | u_var | ) | const |
Get the IBTK::CartGridFunction object being used to specify the value of a particular advection velocity.
◆ registerSourceTerm()
|
virtual |
Register a cell-centered source term. Can optionally turn off outputting the source.
Data management for the registered source term will be handled by the hierarchy integrator.
◆ setSourceTermFunction()
| void IBAMR::AdvDiffHierarchyIntegrator::setSourceTermFunction | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | F_var, |
| SAMRAI::tbox::Pointer< IBTK::CartGridFunction > | F_fcn | ||
| ) |
Supply an IBTK::CartGridFunction object to specify the value of a particular source term.
◆ getSourceTermFunction()
| SAMRAI::tbox::Pointer<IBTK::CartGridFunction> IBAMR::AdvDiffHierarchyIntegrator::getSourceTermFunction | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | F_var | ) | const |
Get the IBTK::CartGridFunction object being used to specify the value of a particular source term.
◆ registerTransportedQuantity()
|
virtual |
Register a cell-centered quantity to be advected and diffused by the hierarchy integrator. Can optionally turn off outputting the quantity.
Data management for the registered quantity will be handled by the hierarchy integrator.
Reimplemented in IBAMR::AdvDiffSemiImplicitHierarchyIntegrator, and IBAMR::BrinkmanAdvDiffSemiImplicitHierarchyIntegrator.
◆ setAdvectionVelocity()
| void IBAMR::AdvDiffHierarchyIntegrator::setAdvectionVelocity | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| SAMRAI::tbox::Pointer< SAMRAI::pdat::FaceVariable< NDIM, double > > | u_var | ||
| ) |
Set the face-centered advection velocity to be used with a particular cell-centered quantity.
- Note
- The specified advection velocity must have been already registered with the hierarchy integrator.
◆ getAdvectionVelocity()
| SAMRAI::tbox::Pointer<SAMRAI::pdat::FaceVariable<NDIM, double> > IBAMR::AdvDiffHierarchyIntegrator::getAdvectionVelocity | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
Get the face-centered advection velocity being used with a particular cell-centered quantity.
◆ setSourceTerm()
| void IBAMR::AdvDiffHierarchyIntegrator::setSourceTerm | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | F_var | ||
| ) |
Set the cell-centered source term to be used with a particular cell-centered quantity.
- Note
- The specified source term must have been already registered with the hierarchy integrator.
◆ getSourceTerm()
| SAMRAI::tbox::Pointer<SAMRAI::pdat::CellVariable<NDIM, double> > IBAMR::AdvDiffHierarchyIntegrator::getSourceTerm | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
Get the cell-centered source term being used with a particular cell-centered quantity.
◆ setDiffusionTimeSteppingType()
| void IBAMR::AdvDiffHierarchyIntegrator::setDiffusionTimeSteppingType | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| TimeSteppingType | time_stepping_type | ||
| ) |
Set the diffusion time integration scheme for a quantity that has been registered with the hierarchy integrator.
◆ getDiffusionTimeSteppingType()
| TimeSteppingType IBAMR::AdvDiffHierarchyIntegrator::getDiffusionTimeSteppingType | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
Get the diffusion time integration scheme for a quantity that has been registered with the hierarchy integrator.
◆ setConvectiveDifferencingType()
| void IBAMR::AdvDiffHierarchyIntegrator::setConvectiveDifferencingType | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| ConvectiveDifferencingType | difference_form | ||
| ) |
Set the convective differencing form for a quantity that has been registered with the hierarchy integrator.
◆ getConvectiveDifferencingType()
| ConvectiveDifferencingType IBAMR::AdvDiffHierarchyIntegrator::getConvectiveDifferencingType | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
Get the convective differencing form for a quantity that has been registered with the hierarchy integrator.
◆ setDiffusionCoefficient()
| void IBAMR::AdvDiffHierarchyIntegrator::setDiffusionCoefficient | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| double | kappa | ||
| ) |
Set the constant scalar diffusion coefficient corresponding to a quantity that has been registered with the hierarchy integrator.
◆ getDiffusionCoefficient()
| double IBAMR::AdvDiffHierarchyIntegrator::getDiffusionCoefficient | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
Get the constant scalar diffusion coefficient corresponding to a quantity that has been registered with the hierarchy integrator.
◆ registerDiffusionCoefficientVariable()
| void IBAMR::AdvDiffHierarchyIntegrator::registerDiffusionCoefficientVariable | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::SideVariable< NDIM, double > > | D_var | ) |
Register a variable scalar diffusion coefficient corresponding to a quantity that has been registered with the hierarchy integrator.
◆ setDiffusionCoefficientFunction()
| void IBAMR::AdvDiffHierarchyIntegrator::setDiffusionCoefficientFunction | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::SideVariable< NDIM, double > > | D_var, |
| SAMRAI::tbox::Pointer< IBTK::CartGridFunction > | D_fcn | ||
| ) |
Supply an IBTK:CartGridFunction object to specify the value of a particular variable diffusion coefficient.
◆ getDiffusionCoefficientFunction()
| SAMRAI::tbox::Pointer<IBTK::CartGridFunction> IBAMR::AdvDiffHierarchyIntegrator::getDiffusionCoefficientFunction | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::SideVariable< NDIM, double > > | D_var | ) | const |
Get the IBTK::CartGridFunction object being used to specify the value of a particular variable diffusion coefficient.
◆ setDiffusionCoefficientVariable()
| void IBAMR::AdvDiffHierarchyIntegrator::setDiffusionCoefficientVariable | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| SAMRAI::tbox::Pointer< SAMRAI::pdat::SideVariable< NDIM, double > > | D_var | ||
| ) |
Set the cell-centered variable diffusion coefficient to be used with a particular cell-centered quantity.
- Note
- The specified source term must have been already registered with the hierarchy integrator.
◆ getDiffusionCoefficientVariable()
| SAMRAI::tbox::Pointer<SAMRAI::pdat::SideVariable<NDIM, double> > IBAMR::AdvDiffHierarchyIntegrator::getDiffusionCoefficientVariable | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
Get the cell-centered variable diffusion coefficient being used with a particular cell-centered quantity.
◆ isDiffusionCoefficientVariable()
| bool IBAMR::AdvDiffHierarchyIntegrator::isDiffusionCoefficientVariable | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
◆ setDampingCoefficient()
| void IBAMR::AdvDiffHierarchyIntegrator::setDampingCoefficient | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| double | lambda | ||
| ) |
Set the scalar linear damping coefficient corresponding to a quantity that has been registered with the hierarchy integrator.
◆ getDampingCoefficient()
| double IBAMR::AdvDiffHierarchyIntegrator::getDampingCoefficient | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
Get the scalar linear damping coefficient corresponding to a quantity that has been registered with the hierarchy integrator.
◆ setInitialConditions()
| void IBAMR::AdvDiffHierarchyIntegrator::setInitialConditions | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| SAMRAI::tbox::Pointer< IBTK::CartGridFunction > | Q_init | ||
| ) |
Set a grid function to provide initial conditions for a quantity that has been registered with the hierarchy integrator.
◆ getInitialConditions()
| SAMRAI::tbox::Pointer<IBTK::CartGridFunction> IBAMR::AdvDiffHierarchyIntegrator::getInitialConditions | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
Get the grid function being used to provide initial conditions for a quantity that has been registered with the hierarchy integrator.
◆ setPhysicalBcCoef()
| void IBAMR::AdvDiffHierarchyIntegrator::setPhysicalBcCoef | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| SAMRAI::solv::RobinBcCoefStrategy< NDIM > * | Q_bc_coef | ||
| ) |
Set an object to provide boundary conditions for a scalar-valued quantity that has been registered with the hierarchy integrator.
- See also
- IBTK::muParserRobinBcCoefs
◆ setPhysicalBcCoefs()
| void IBAMR::AdvDiffHierarchyIntegrator::setPhysicalBcCoefs | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > & | Q_bc_coef | ||
| ) |
Set objects to provide boundary conditions for a vector-valued quantity that has been registered with the hierarchy integrator.
- See also
- IBTK::muParserRobinBcCoefs
◆ getPhysicalBcCoefs()
| std::vector<SAMRAI::solv::RobinBcCoefStrategy<NDIM>*> IBAMR::AdvDiffHierarchyIntegrator::getPhysicalBcCoefs | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
Get objects used to provide boundary conditions for a scalar- or vector-valued quantity that has been registered with the hierarchy integrator.
◆ setHelmholtzSolver()
| void IBAMR::AdvDiffHierarchyIntegrator::setHelmholtzSolver | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| SAMRAI::tbox::Pointer< IBTK::PoissonSolver > | helmholtz_solver | ||
| ) |
Register a solver for the Helmholtz equation (time-discretized diffusion equation).
◆ getHelmholtzSolver()
| SAMRAI::tbox::Pointer<IBTK::PoissonSolver> IBAMR::AdvDiffHierarchyIntegrator::getHelmholtzSolver | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) |
Get the solver for the Helmholtz equation (time-discretized diffusion equation) used by this solver class.
◆ setHelmholtzSolversNeedInit()
| void IBAMR::AdvDiffHierarchyIntegrator::setHelmholtzSolversNeedInit | ( | ) |
Indicate that all of the Helmholtz solvers should be (re-)initialized before the next time step.
◆ setHelmholtzSolverNeedsInit()
| void IBAMR::AdvDiffHierarchyIntegrator::setHelmholtzSolverNeedsInit | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) |
Indicate that the Helmholtz solver should be (re-)initialized before the next time step.
◆ setHelmholtzRHSOperator()
| void IBAMR::AdvDiffHierarchyIntegrator::setHelmholtzRHSOperator | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| SAMRAI::tbox::Pointer< IBTK::LaplaceOperator > | helmholtz_rhs_operator | ||
| ) |
Register an operator to use to evaluate the right-hand side for the Helmholtz solver (time-discretized diffusion equation).
◆ getHelmholtzRHSOperator()
| SAMRAI::tbox::Pointer<IBTK::LaplaceOperator> IBAMR::AdvDiffHierarchyIntegrator::getHelmholtzRHSOperator | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) |
Get the operator to use to evaluate the right-hand side for the Helmholtz solver (time-discretized diffusion equation).
◆ setHelmholtzRHSOperatorsNeedInit()
| void IBAMR::AdvDiffHierarchyIntegrator::setHelmholtzRHSOperatorsNeedInit | ( | ) |
Indicate that all of the operators to evaluate the right-hand side for the Helmholtz solver should be (re-)initialized before the next time step.
◆ setHelmholtzRHSOperatorNeedsInit()
| void IBAMR::AdvDiffHierarchyIntegrator::setHelmholtzRHSOperatorNeedsInit | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) |
Indicate that the operator to evaluate the right-hand side for the Helmholtz solver should be (re-)initialized before the next time step.
◆ initializeHierarchyIntegrator()
|
overridevirtual |
Initialize the variables, basic communications algorithms, solvers, and other data structures used by this time integrator object.
This method is called automatically by initializePatchHierarchy() prior to the construction of the patch hierarchy. It is also possible for users to make an explicit call to initializeHierarchyIntegrator() prior to calling initializePatchHierarchy().
Implements IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::AdvDiffSemiImplicitHierarchyIntegrator, IBAMR::AdvDiffPredictorCorrectorHierarchyIntegrator, and IBAMR::BrinkmanAdvDiffSemiImplicitHierarchyIntegrator.
◆ preprocessIntegrateHierarchy()
|
overridevirtual |
Prepare to advance the data from current_time to new_time.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::AdvDiffSemiImplicitHierarchyIntegrator, IBAMR::AdvDiffPredictorCorrectorHierarchyIntegrator, and IBAMR::BrinkmanAdvDiffSemiImplicitHierarchyIntegrator.
◆ registerResetFunction()
| void IBAMR::AdvDiffHierarchyIntegrator::registerResetFunction | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| ResetPropertiesFcnPtr | callback, | ||
| void * | ctx | ||
| ) |
◆ setResetPriority()
| void IBAMR::AdvDiffHierarchyIntegrator::setResetPriority | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var, |
| int | priority | ||
| ) |
- Note
- Variables will be reset sequentially according to their priority, from lowest to highest. The reset functions registered to each variable will be called according to the order in which they were registered. If no priority is set for a variable, its reset functions will be called after those with priority, in no particular order.
◆ getResetFunctions()
| std::vector<ResetPropertiesFcnPtr> IBAMR::AdvDiffHierarchyIntegrator::getResetFunctions | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
◆ getResetPriority()
| int IBAMR::AdvDiffHierarchyIntegrator::getResetPriority | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | Q_var | ) | const |
◆ getMaximumTimeStepSizeSpecialized()
|
overrideprotectedvirtual |
Return the maximum stable time step size.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::AdvDiffPredictorCorrectorHierarchyIntegrator.
◆ initializeCompositeHierarchyDataSpecialized()
|
overrideprotectedvirtual |
Initialize composite hierarchy data.
The method initializes variables that may require the full grid hierarchy to be already created.
Reimplemented from IBTK::HierarchyIntegrator.
◆ resetHierarchyConfigurationSpecialized()
|
overrideprotectedvirtual |
Reset cached hierarchy dependent data.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::AdvDiffSemiImplicitHierarchyIntegrator, and IBAMR::AdvDiffPredictorCorrectorHierarchyIntegrator.
◆ putToDatabaseSpecialized()
|
overrideprotectedvirtual |
Write out specialized object state to the given database.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::AdvDiffSemiImplicitHierarchyIntegrator.
◆ registerVariables()
|
protected |
Standard variable registration.
◆ operator=()
|
privatedelete |
- Note
- This operator is not implemented and should not be used.
- Parameters
-
that The value to assign to this object.
- Returns
- A reference to this object.
◆ getFromInput()
|
private |
Read input values from a given database.
◆ getFromRestart()
|
private |
Read object state from the restart file and initialize class data members. The database from which the restart data are read is determined by the object_name specified in the class constructor.
◆ getName()
|
inherited |
Return the name of the hierarchy integrator object.
◆ initializePatchHierarchy()
|
virtualinherited |
Initialize the AMR patch hierarchy and data defined on the hierarchy at the start of a computation. If the computation is begun from a restart file, the patch hierarchy and patch data are read from the hierarchy database. Otherwise, the patch hierarchy and patch data are initialized by the gridding algorithm associated with the integrator object.
The implementation of this function assumes that the hierarchy exists upon entry to the function, but that it contains no patch levels. On return from this function, the state of the integrator object will be such that it is possible to step through time via the advanceHierarchy() function.
Reimplemented in IBAMR::IBHierarchyIntegrator, IBAMR::INSVCStaggeredHierarchyIntegrator, IBAMR::INSStaggeredHierarchyIntegrator, IBAMR::INSCollocatedHierarchyIntegrator, IBAMR::IBExplicitHierarchyIntegrator, IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredConservativeHierarchyIntegrator.
◆ advanceHierarchy()
|
virtualinherited |
Integrate data on all patches on all levels of the patch hierarchy over the specified time increment.
◆ getMinimumTimeStepSize()
|
inherited |
Return the current value of the minimum time step size for the integrator object.
Subclasses can control the method used to determined the time step size by overriding the protected virtual member function getMinimumTimeStepSizeSpecialized().
◆ getMaximumTimeStepSize()
|
inherited |
Return the current value of the maximum time step size for the integrator object.
Subclasses can control the method used to determined the time step size by overriding the protected virtual member function getMaximumTimeStepSizeSpecialized().
◆ synchronizeHierarchyData()
|
inherited |
Synchronize data defined on the grid hierarchy.
Subclasses can control the method used to synchronize data on the grid hierarchy by overriding the protected virtual member function synchronizeHierarchyDataSpecialized().
◆ resetTimeDependentHierarchyData()
|
inherited |
Reset the current data to equal the new data, update the time level of the current data, and deallocate the scratch and new data.
Subclasses can control the method used to reset data on the grid hierarchy by overriding the protected virtual member function resetTimeDependentHierarchyDataSpecialized().
◆ resetIntegratorToPreadvanceState()
|
inherited |
Reset the hierarchy integrator to the state at the beginning of the current time step.
Subclasses can control the method used to reset data on the grid hierarchy by overriding the protected virtual member function resetTimeDependentHierarchyDataSpecialized().
◆ regridHierarchy()
|
virtualinherited |
Virtual method to regrid the patch hierarchy.
A default implementation is provided that calls GriddingAlgorithm::regidAllFinerLevels() to regrid the patch hierarchy. Subclasses can control the method used to regrid the patch hierarchy by overriding this public virtual member function.
Before regridding, this method calls regridHierarchyBeginSpecialized() on the current integrator and all child integrators.
After regridding and (optionally) checking the new grid volume, this method calls regridHierarchyEndSpecialized() on the current integrator and all child integrators. It then calls the following methods (and, therefore, the specialized methods on the current and all child integrators) in the following order:
- initializeCompositeHierarchyData
- synchronizeHierarchyData
- Warning
- This class assumes, but does not enforce, that this method is only called on the parent integrator. A future release of IBAMR will enforce this assumption.
◆ atRegridPoint()
|
inherited |
Return a boolean value that indicates whether regridding should occur at the current time step.
Subclasses can control the method used to trigger adaptive regridding by overriding the protected virtual member function atRegridPointSpecialized().
◆ getIntegratorTime()
|
inherited |
Return the current integration time.
◆ getStartTime()
|
inherited |
Return the initial integration time.
◆ getEndTime()
|
inherited |
Return the final integration time.
◆ getIntegratorStep()
|
inherited |
Return the number of time steps taken by the integrator.
◆ getMaxIntegratorSteps()
|
inherited |
Return the maximum number of time steps allowed by the integrator.
◆ stepsRemaining()
|
inherited |
Return true if any time steps remain, false otherwise.
◆ updateWorkloadEstimates()
|
inherited |
Update workload estimates on each level of the patch hierarchy. Does nothing unless a load balancer has previously been attached via HierarchyIntegrator::register_load_balancer. This function is usually called immediately before regridding so that, should a load balancer be registered with the current class, that load balancer can distribute patches in a way that gives each processor a roughly equal amount of work (instead of simply an equal number of cells).
If you want to visualize the workload then you will have to ensure that workload estimates are recomputed after regridding (by default they are not). This is because workload estimates are only used when moving data between processors: they are computed immediately before the domain is repartitioned and, therefore, their patch data is always invalid at points where output is written. The easiest way to get around this is to enable logging (which will result in workload estimates being updated after regridding) or to manually call updateWorkloadEstimates at points where output is written. The former is more efficient since most applications regrid less frequently than they write visualization files.
Once the data is available, it can be attached to the visit data writer in the usual way. Here is one way to do set this up at the same time the visit data writer is registered:
- Note
- This function computes workloads by setting the estimated work value on all cells to 1 and then calling addWorkloadEstimate on the current object and on each child hierarchy integrator.
- The workload estimate itself is stored in the variable with index HierarchyIntegrator::d_workload_idx.
@seealso HierarchyIntegrator::getWorkloadDataIndex()
◆ getPatchHierarchy()
|
inherited |
Return a pointer to the patch hierarchy managed by the integrator.
◆ getGriddingAlgorithm()
|
inherited |
Return a pointer to the gridding algorithm object managed by the integrator.
◆ registerLoadBalancer()
|
virtualinherited |
Register a load balancer for non-uniform load balancing.
- Note
- inheriting classes may reimplement this method in such a way that
load_balanceris registered with another object; e.g., IBHierarchyIntegrator passesload_balancerto its IBStrategy object. It will still usually be necessary to call HierarchyIntegrator::registerLoadBalancer at the beginning top of such overloaded functions. -
If it does not already exist, calling this function will also register a cell variable for containing workload estimates (and subsequently register that variable with the load balancer): The variable index is
d_workload_idx. All inheriting classes assume that this is the cell variable associated with workload estimates and will write their own data into these arrays.
Reimplemented in IBAMR::IBHierarchyIntegrator.
◆ getWorkloadDataIndex()
|
inherited |
Return the workload variable's patch data index. If the workload variable has not yet been set up by this object (or, should it exist, this object's parent hierarchy integrator) then IBTK::invalid_index is returned instead.
- Note
- this is only implemented since this information is not readily available from the variable database and there is no other way to access this variable. The main use of this variable is for optionally adding the workload estimates to the VisIt data writer.
◆ registerVisItDataWriter()
|
inherited |
Register a VisIt data writer so the integrator can output data files that may be postprocessed with the VisIt visualization tool.
◆ getVisItDataWriter()
|
inherited |
Get a pointer to the VisIt data writer registered with the solver.
◆ setupPlotData()
|
inherited |
Prepare variables for plotting.
Subclasses can control the method used to setup plot data by overriding the protected virtual member function setupPlotData().
- Note
- Subclasses are allowed to require that this function be called immediately before writing visualization data.
◆ getNumberOfCycles()
|
virtualinherited |
Routines to implement the time integration scheme.
Virtual method to return the number of cycles to perform for the present time step.
Reimplemented in IBAMR::INSHierarchyIntegrator, IBAMR::AdvDiffSemiImplicitHierarchyIntegrator, IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, and IBAMR::IBImplicitStaggeredHierarchyIntegrator.
◆ getCurrentCycleNumber()
|
virtualinherited |
Virtual method to return the current cycle number within the present time step.
The default implementation returns a value of -1 when it is not advancing the hierarchy.
◆ getCurrentTimeStepSize()
|
virtualinherited |
Virtual method to return the current time step size.
The default implementation returns the value numeric_limits<>::quiet_NaN() when it is not advancing the hierarchy.
◆ integrateHierarchy()
|
inherited |
Advance data from current_time to new_time. The current implementation calls doIntegrateHierarchy() followed by executeIntegrateHierarchyCallbackFcns().
◆ skipCycle()
|
inherited |
Method to skip a cycle of the time integration scheme (e.g. for cases in which time integration is handled by another class).
◆ postprocessIntegrateHierarchy()
|
virtualinherited |
Virtual method to clean up data following call(s) to integrateHierarchy().
A default implementation is provided that resets the current values of num_cycles and the time step size.
- Note
- Inheriting classes should call their base class versions of this method.
Reimplemented in IBAMR::INSHierarchyIntegrator, IBAMR::AdvDiffSemiImplicitHierarchyIntegrator, IBAMR::INSVCStaggeredHierarchyIntegrator, IBAMR::IBHierarchyIntegrator, IBAMR::INSStaggeredHierarchyIntegrator, IBAMR::INSCollocatedHierarchyIntegrator, IBAMR::AdvDiffPredictorCorrectorHierarchyIntegrator, IBAMR::BrinkmanAdvDiffSemiImplicitHierarchyIntegrator, IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator, IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, IBAMR::IBImplicitStaggeredHierarchyIntegrator, IBAMR::IBExplicitHierarchyIntegrator, and IBAMR::IBInterpolantHierarchyIntegrator.
◆ registerPreprocessIntegrateHierarchyCallback()
|
inherited |
Register a callback function to enable further specialization of preprocessIntegrateHierarchy().
◆ registerIntegrateHierarchyCallback()
|
inherited |
Register a callback function to enable further specialization of integrateHierarchy().
◆ registerPostprocessIntegrateHierarchyCallback()
|
inherited |
Register a callback function to enable further specialization of postprocessIntegrateHierarchy().
◆ registerApplyGradientDetectorCallback()
|
inherited |
Register a callback function to enable further specialization of applyGradientDetector().
◆ registerRegridHierarchyCallback()
|
inherited |
Register a callback function to enable further specialization of regridHierarchy().
- Note
- This function will be called after all data owned by the hierarchy is initialized and set, but before the data is synchronized. If data owned by the integrator is used in this function, it should be synchronized prior to use by an appropriate coarsening operation.
◆ initializeCompositeHierarchyData()
|
inherited |
Perform data initialization after the entire hierarchy has been constructed.
◆ initializeLevelData() [1/2]
|
overrideinherited |
Implementations of functions declared in the SAMRAI::mesh::StandardTagAndInitStrategy abstract base class.
Initialize data on a new level after it is inserted into an AMR patch hierarchy by the gridding algorithm.
- Note
- Subclasses should not override the implementation of this function provided by class HierarchyIntegrator. Instead, they should override the protected virtual member function initializeLevelDataSpecialized().
◆ initializeLevelData() [2/2]
|
pure virtualinherited |
Initialize data on a new level after it is inserted into an AMR patch hierarchy by the gridding algorithm. The level number indicates that of the new level.
Generally, when data is set, it is interpolated from coarser levels in the hierarchy. If the old level pointer in the argument list is non-null, then data is copied from the old level to the new level on regions of intersection between those levels before interpolation occurs. In this case, the level number must match that of the old level. The specific operations that occur when initializing level data are determined by the particular solution methods in use; i.e., in the subclass of this abstract base class.
The boolean argument initial_time indicates whether the level is being introduced for the first time (i.e., at initialization time), or after some regrid process during the calculation beyond the initial hierarchy construction. This information is provided since the initialization of the data may be different in each of those circumstances. The can_be_refined boolean argument indicates whether the level is the finest allowable level in the hierarchy.
◆ resetHierarchyConfiguration() [1/2]
|
overrideinherited |
Reset cached hierarchy dependent data.
- Note
- Subclasses should not override the implementation of this function provided by class HierarchyIntegrator. Instead, they should override the protected virtual member function resetHierarchyConfigurationSpecialized().
◆ resetHierarchyConfiguration() [2/2]
|
pure virtualinherited |
After hierarchy levels have changed and data has been initialized on the new levels, this routine can be used to reset any information needed by the solution method that is particular to the hierarchy configuration. For example, the solution procedure may cache communication schedules to amortize the cost of data movement on the AMR patch hierarchy. This function will be called by the gridding algorithm after the initialization occurs so that the algorithm-specific subclass can reset such things. Also, if the solution method must make the solution consistent across multiple levels after the hierarchy is changed, this process may be invoked by this routine. Of course the details of these processes are determined by the particular solution methods in use.
The level number arguments indicate the coarsest and finest levels in the current hierarchy configuration that have changed. It should be assumed that all intermediate levels have changed as well.
◆ applyGradientDetector() [1/2]
|
overrideinherited |
Set integer tags to "one" in cells where refinement of the given level should occur according to user-supplied feature detection criteria.
- Note
- Subclasses should not override the implementation of this function provided by class HierarchyIntegrator. Instead, they should override the protected virtual member function applyGradientDetectorSpecialized().
◆ applyGradientDetector() [2/2]
|
virtualinherited |
Set integer tags to "one" in cells where refinement of the given level should occur according to some user-supplied gradient criteria. The double time argument is the regrid time. The integer "tag_index" argument is the patch descriptor index of the cell-centered integer tag array on each patch in the hierarchy. The boolean argument initial_time indicates whether the level is being subject to refinement at the initial simulation time. If it is false, then the error estimation process is being invoked at some later time after the AMR hierarchy was initially constructed. Typically, this information is passed to the user's patch tagging routines since the error estimator or gradient detector may be different in each case.
The boolean uses_richardson_extrapolation_too is true when Richardson extrapolation error estimation is used in addition to the gradient detector, and false otherwise. This argument helps the user to manage multiple regridding criteria.
This routine is only when gradient detector is being used. It is virtual with an empty implementation here (rather than pure virtual) so that users are not required to provide an implementation when the function is not needed.
◆ getContext()
|
inherited |
Routines to access to the variable contexts maintained by the integrator.
Return a pointer the variable context corresponding to the specified variable context type.
◆ getCurrentContext()
|
inherited |
Return a pointer to the "current" variable context used by integrator. Current data corresponds to state data at the beginning of a time step, or when a new level is initialized.
◆ getNewContext()
|
inherited |
Return a pointer to the "new" variable context used by integrator. New data corresponds to advanced state data at the end of a time step. The data is one time step later than the "current" data.
◆ getScratchContext()
|
inherited |
Return a pointer to the "scratch" variable context used by integrator. Scratch data typically corresponds to storage that user-routines in the concrete GodunovAdvector object manipulate; in particular, scratch data contains ghost cells.
◆ getPlotContext()
|
inherited |
Return a pointer to the "plot" variable context used by integrator. Plot data is only read from by the VisItDataWriter and is allocated by setupPlotData() and deallocated by regridHierarchyBegin().
◆ isAllocatedPatchData()
|
inherited |
Check whether a patch data index corresponds to allocated data over the specified range of patch level numbers.
NOTE: This method will return "false" without error for invalid (i.e., negative) patch data indices.
◆ allocatePatchData()
|
inherited |
Allocate a patch data index over the specified range of patch level numbers.
◆ deallocatePatchData()
|
inherited |
Deallocate a patch data index over the specified range of patch level numbers.
◆ getHierarchyMathOps()
|
inherited |
Routines to access utility classeses managed by the integrator.
◆ registerVariable() [1/2]
|
inherited |
Routines to register new variables with the integrator.
Register a state variable with the integrator. When a refine operator is specified, the data for the variable are automatically maintained as the patch hierarchy evolves.
All state variables are registered with three contexts: current, new, and scratch. The current context of a state variable is maintained from time step to time step and, if the necessary coarsen and refine operators are specified, as the patch hierarchy evolves.
◆ registerVariable() [2/2]
|
inherited |
Register a variable with the integrator that may not be maintained from time step to time step.
By default, variables are registered with the scratch context, which is deallocated after each time step.
◆ putToDatabase()
|
overridevirtualinherited |
Implementations of functions declared in the SAMRAI::tbox::Serializable abstract base class.
Write out object state to the given database.
- Note
- Subclasses should not override the implementation of this function provided by class HierarchyIntegrator. Instead, they should override the protected virtual member function putToDatabaseSpecialized().
Implements SAMRAI::tbox::Serializable.
◆ integrateHierarchySpecialized()
|
protectedpure virtualinherited |
Pure virtual function that integrates the hierarchy from current_time to new_time.
Implementations of this virtual function are not required to synchronize data on the patch hierarchy. Data synchronization may be done (optionally) in a specialization of the public virtual member function postprocessIntegrateHierarchy().
This function is called by integrateHierarchy() prior to the execution of callbacks.
- Note
- Inheriting classes should call their base class versions of this method.
Implemented in IBAMR::AdvDiffSemiImplicitHierarchyIntegrator, IBAMR::INSStaggeredHierarchyIntegrator, IBAMR::INSCollocatedHierarchyIntegrator, IBAMR::BrinkmanAdvDiffSemiImplicitHierarchyIntegrator, IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, IBAMR::IBExplicitHierarchyIntegrator, IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator, IBAMR::AdvDiffPredictorCorrectorHierarchyIntegrator, IBAMR::IBImplicitStaggeredHierarchyIntegrator, and IBAMR::IBInterpolantHierarchyIntegrator.
◆ regridHierarchyBeginSpecialized()
|
protectedvirtualinherited |
Perform any necessary work relevant to data owned by the current integrator prior to regridding (e.g., calculating divergences). An empty default implementation is provided.
Reimplemented in IBAMR::INSVCStaggeredHierarchyIntegrator, IBAMR::INSStaggeredHierarchyIntegrator, IBAMR::IBHierarchyIntegrator, and IBAMR::IBExplicitHierarchyIntegrator.
◆ regridHierarchyEndSpecialized()
|
protectedvirtualinherited |
Perform any necessary work relevant to data owned by the current integrator after regridding (e.g., calculating divergences). An empty default implementation is provided.
Reimplemented in IBAMR::INSVCStaggeredHierarchyIntegrator, IBAMR::INSStaggeredHierarchyIntegrator, IBAMR::IBHierarchyIntegrator, and IBAMR::IBExplicitHierarchyIntegrator.
◆ getMinimumTimeStepSizeSpecialized()
|
protectedvirtualinherited |
Virtual method to compute an implementation-specific minimum stable time step size. Implementations should ensure that the returned time step is consistent across all processors.
A default implementation is provided that returns min(dt_max,dt_growth_factor*dt_current). The growth condition prevents excessive changes in the time step size as the computation progresses.
◆ synchronizeHierarchyDataSpecialized()
|
protectedvirtualinherited |
Virtual method to perform implementation-specific data synchronization.
A default implementation is provided that synchronizes state data registered with the HierarchyIntegrator object using the coarsen operations specified by calls to registerVariable().
◆ resetTimeDependentHierarchyDataSpecialized()
|
protectedvirtualinherited |
Virtual method to perform implementation-specific data reset operations.
A default implementation is provided that first swaps the current and new PatchData pointers, and then deallocates the new and scratch data contexts.
Reimplemented in IBAMR::AdvDiffPredictorCorrectorHierarchyIntegrator.
◆ resetIntegratorToPreadvanceStateSpecialized()
|
protectedvirtualinherited |
Virtual method to perform implementation-specific data reset operations.
A default implementation is provided that deallocates the new and scratch data contexts when data associated with those contexts have been allocated.
Reimplemented in IBAMR::AdvDiffPredictorCorrectorHierarchyIntegrator.
◆ atRegridPointSpecialized()
|
protectedvirtualinherited |
Virtual method to provide implementation-specific function to determine whether regridding should occur at the current time step.
A default implementation is provided that indicates that the hierarchy should be regridded at a fixed integer interval of time steps unless a parent integrator has been registered with this integrator. If a parent integrator has been registered with this integrator, atRegridPointSpecialized() returns false, in order to allow the parent integrator to control the timing of regridding.
Reimplemented in IBAMR::IBHierarchyIntegrator.
◆ setupPlotDataSpecialized()
|
protectedvirtualinherited |
Virtual method to perform implementation-specific visualization setup.
An empty default implementation is provided.
Reimplemented in IBAMR::INSVCStaggeredHierarchyIntegrator, IBAMR::INSStaggeredHierarchyIntegrator, IBAMR::INSCollocatedHierarchyIntegrator, IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator.
◆ initializeLevelDataSpecialized()
|
protectedvirtualinherited |
Virtual method to perform implementation-specific data initialization on a new level after it is inserted into an AMR patch hierarchy by the gridding algorithm.
An empty default implementation is provided.
Reimplemented in IBAMR::INSVCStaggeredHierarchyIntegrator, IBAMR::INSStaggeredHierarchyIntegrator, IBAMR::IBHierarchyIntegrator, IBAMR::INSCollocatedHierarchyIntegrator, IBAMR::AdvDiffPredictorCorrectorHierarchyIntegrator, IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator.
◆ applyGradientDetectorSpecialized()
|
protectedvirtualinherited |
Virtual method to perform implementation-specific cell tagging operations.
An empty default implementation is provided.
Reimplemented in IBAMR::INSVCStaggeredHierarchyIntegrator, IBAMR::INSStaggeredHierarchyIntegrator, IBAMR::IBHierarchyIntegrator, IBAMR::INSCollocatedHierarchyIntegrator, IBAMR::AdvDiffPredictorCorrectorHierarchyIntegrator, IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator.
◆ addWorkloadEstimate()
|
protectedvirtualinherited |
Virtual method to provide implementation-specific workload estimate calculations. This method will be called on each registered child integrator. The intent of this function is that any HierarchyIntegrator object that manages data whose work varies from SAMRAI cell to SAMRAI cell will represent its additional workload by summing estimates into the workload_data_idx variable.
- Note
- The default version of this function, i.e., HierarchyIntegrator::addWorkloadEstimate(), does nothing.
Reimplemented in IBAMR::IBHierarchyIntegrator.
◆ executePreprocessIntegrateHierarchyCallbackFcns()
|
protectedvirtualinherited |
Execute any user-specified preprocessIntegrateHierarchy callback functions.
◆ executeIntegrateHierarchyCallbackFcns()
|
protectedvirtualinherited |
Execute any user-specified integrateHierarchy callback functions.
◆ executePostprocessIntegrateHierarchyCallbackFcns()
|
protectedvirtualinherited |
Execute any user-specified postprocessIntegrateHierarchy callback functions.
◆ executeApplyGradientDetectorCallbackFcns()
|
protectedvirtualinherited |
Execute any user-specified applyGradientDetector callback functions.
◆ executeRegridHierarchyCallbackFcns()
|
protectedvirtualinherited |
Execute any user-specified regridHierarchy callback functions.
◆ registerGhostfillRefineAlgorithm()
|
protectedinherited |
Register a ghost cell-filling refine algorithm.
◆ registerProlongRefineAlgorithm()
|
protectedinherited |
Register a data-prolonging refine algorithm.
◆ registerCoarsenAlgorithm()
|
protectedinherited |
Register a coarsen algorithm.
◆ getGhostfillRefineAlgorithm()
|
protectedinherited |
Get ghost cell-filling refine algorithm.
◆ getProlongRefineAlgorithm()
|
protectedinherited |
Get data-prolonging refine algorithm.
◆ getCoarsenAlgorithm()
|
protectedinherited |
Get coarsen algorithm.
◆ getGhostfillRefineSchedules()
|
protectedinherited |
Get ghost cell-filling refine schedules.
◆ getProlongRefineSchedules()
|
protectedinherited |
Get data-prolonging refine schedules.
- Note
- These schedules are allocated only for level numbers >= 1.
◆ getCoarsenSchedules()
|
protectedinherited |
Get coarsen schedules.
- Note
- These schedules are allocated only for level numbers >= 1.
◆ registerChildHierarchyIntegrator()
|
protectedinherited |
Register a "child" integrator object with this integrator object.
- Note
- Multiple child integrator objects may be registered with a single parent integrator object.
◆ registerParentHierarchyIntegrator()
|
protectedinherited |
Register a "parent" integrator object with this integrator object.
- Note
- Only a single parent integrator object may be registered with a particular child integrator object.
◆ buildHierarchyMathOps()
|
protectedinherited |
Build the HierarchyMathOps object.
◆ setupTagBuffer()
|
protectedinherited |
Setup the tag buffer.
◆ regriddingHierarchy()
|
inlineprotectedinherited |
Returns true when we are regridding the patch hierarchy.
◆ atRegridTimeStep()
|
inlineprotectedinherited |
Returns true when we are executing a time step in which a regridding operation was performed.
◆ getLevelDt()
|
virtualinherited |
Determine time increment to advance data on level. The recompute_dt option specifies whether to compute the timestep using the current level data or to return the value stored by the time integrator. The default true setting means the timestep will be computed if no value is supplied.
This routine is only when Richardson extrapolation is being used. It is virtual with an empty implementation here (rather than pure virtual) so that users are not required to provide an implementation when the function is not needed.
◆ advanceLevel()
|
virtualinherited |
Advance data on all patches on specified patch level from current time (current_time) to new time (new_time). This routine is called only during time-dependent regridding procedures, such as Richardson extrapolation. It is virtual with an empty implementation here (rather than pure virtual) so that users are not required to provide an implementation when the function is not needed. The boolean arguments are used to determine the state of the algorithm and the data when the advance routine is called. Note that this advance function is also used during normal time integration steps.
When this function is called, the level data required to begin the advance must be allocated and be defined appropriately. Typically, this is equivalent to what is needed to initialize a new level after regridding. Upon exiting this routine, both current and new data may exist on the level. This data is needed until level synchronization occurs, in general. Current and new data may be reset by calling the member function resetTimeDependentData().
This routine is called from two different points within the Richardson exptrapolation process: to advance a temporary level that is coarser than the hierarchy level on which error estimation is performed, and to advance the hierarchy level itself. In the first case, the values of the boolean flags are:
- first_step = true.
- last_step = true.
- regrid_advance = true.
In the second case, the values of the boolean flags are:
- first_step (when regridding during time integration sequence) = true when the level is not coarsest level to synchronize immediately before the regridding process; else, false. (when generating initial hierarchy construction) = true, even though there may be multiple advance steps.
- last_step = true when the advance is the last in the Richardson extrapolation step sequence; else false.
- regrid_advance = true.
◆ resetTimeDependentData()
|
virtualinherited |
Reset time-dependent data storage for the specified patch level.
This routine only applies when Richardson extrapolation is being used. It is virtual with an empty implementation here (rather than pure virtual) so that users are not required to provide an implementation when the function is not needed.
◆ resetDataToPreadvanceState()
|
virtualinherited |
Reset data on the patch level by destroying all patch data other than that which is needed to initialize the solution on that level. In other words, this is the data needed to begin a time integration step on the level.
This routine is only when Richardson extrapolation is being used. It is virtual with an empty implementation here (rather than pure virtual) so that users are not required to provide an implementation when the function is not needed.
◆ applyRichardsonExtrapolation()
|
virtualinherited |
Set integer tags to "one" in cells where refinement of the given level should occur according to some user-supplied Richardson extrapolation criteria. The "error_data_time" argument is the regrid time. The "deltat" argument is the time increment to advance the solution on the level to be refined. Note that that level is finer than the level in the argument list, in general. The ratio between the argument level and the actual hierarchy level is given by the integer "coarsen ratio".
The integer "tag_index" argument is the patch descriptor index of the cell-centered integer tag array on each patch in the hierarchy.
The boolean argument initial_time indicates whether the level is being subject to refinement at the initial simulation time. If it is false, then the error estimation process is being invoked at some later time after the AMR hierarchy was initially constructed. Typically, this information is passed to the user's patch tagging routines since the application of the Richardson extrapolation process may be different in each case.
The boolean uses_gradient_detector_too is true when a gradient detector procedure is used in addition to Richardson extrapolation, and false otherwise. This argument helps the user to manage multiple regridding criteria.
This routine is only when Richardson extrapolation is being used. It is virtual with an empty implementation here (rather than pure virtual) so that users are not required to provide an implementation when the function is not needed.
◆ coarsenDataForRichardsonExtrapolation()
|
virtualinherited |
Coarsen solution data from level to coarse_level for Richardson extrapolation. Note that this routine will be called twice during the Richardson extrapolation error estimation process, once to set data on the coarser level and once to coarsen data from after advancing the fine level. The init_coarse_level boolean argument indicates whether data is set on the coarse level by coarsening the "old" time level solution or by coarsening the "new" solution on the fine level (i.e., after it has been advanced).
This routine is only when Richardson extrapolation is being used. It is virtual with an empty implementation here (rather than pure virtual) so that users are not required to provide an implementation when the function is not needed.
Member Data Documentation
◆ d_integrator_is_initialized
|
protected |
◆ d_cfl_max
|
protected |
Advective CFL condition.
◆ d_default_diffusion_time_stepping_type
|
protected |
Default diffusion time integration method.
◆ d_default_convective_difference_form
|
protected |
Default convective differencing type.
◆ d_u_var
|
protected |
Advection velocity data.
◆ d_u_is_div_free
|
protected |
◆ d_u_fcn
|
protected |
◆ d_F_var
|
protected |
Source term data.
◆ d_F_fcn
|
protected |
◆ d_F_output
|
protected |
◆ d_diffusion_coef_var
|
protected |
Diffusion coefficient data
◆ d_diffusion_coef_rhs_var
|
protected |
◆ d_diffusion_coef_fcn
|
protected |
◆ d_diffusion_coef_rhs_map
|
protected |
◆ d_Q_var
|
protected |
Transported quantities.
◆ d_Q_rhs_var
|
protected |
◆ d_Q_u_map
|
protected |
◆ d_Q_F_map
|
protected |
◆ d_Q_Q_rhs_map
|
protected |
◆ d_Q_diffusion_time_stepping_type
|
protected |
◆ d_Q_difference_form
|
protected |
◆ d_Q_diffusion_coef
|
protected |
◆ d_Q_diffusion_coef_variable
|
protected |
◆ d_Q_is_diffusion_coef_variable
|
protected |
◆ d_Q_damping_coef
|
protected |
◆ d_Q_init
|
protected |
◆ d_Q_bc_coef
|
protected |
◆ d_Q_output
|
protected |
◆ d_Q_reset_fcns
|
protected |
Objects to keep track of the resetting functions.
◆ d_Q_reset_fcns_ctx
|
protected |
◆ d_Q_reset_priority
|
protected |
◆ d_hier_cc_data_ops
|
protected |
◆ d_hier_sc_data_ops
|
protected |
◆ d_hier_bdry_fill_ops
|
protected |
◆ d_no_fill_op
|
protected |
◆ d_sol_vecs
|
protected |
◆ d_rhs_vecs
|
protected |
◆ d_helmholtz_solver_type
|
protected |
◆ d_helmholtz_precond_type
|
protected |
◆ d_helmholtz_sub_precond_type
|
protected |
◆ d_helmholtz_solver_db
|
protected |
◆ d_helmholtz_precond_db
|
protected |
◆ d_helmholtz_sub_precond_db
|
protected |
◆ d_helmholtz_solvers
|
protected |
◆ d_helmholtz_rhs_ops
|
protected |
◆ d_helmholtz_solvers_need_init
|
protected |
◆ d_helmholtz_rhs_ops_need_init
|
protected |
◆ d_coarsest_reset_ln
|
protected |
◆ d_finest_reset_ln
|
protected |
◆ d_object_name
|
protectedinherited |
◆ d_registered_for_restart
|
protectedinherited |
◆ d_hierarchy
|
protectedinherited |
◆ d_gridding_alg
|
protectedinherited |
◆ d_load_balancer
|
protectedinherited |
◆ d_workload_var
|
protectedinherited |
◆ d_workload_idx
|
protectedinherited |
The index of the workload estimate variable. If the current integrator is a child integrator then this variable index may not be set to the correct variable index since the parent is assumed to manage the variable, and the correct index is always provided when calling HierarchyIntegrator::addWorkloadEstimate() from parent integrators.
If necessary, this variable can be retrieved from the variable database under the name object_name + "::workload", where object_name is the name of the parent hierarchy integrator.
◆ d_hierarchy_is_initialized
|
protectedinherited |
◆ d_may_need_to_reset_hierarchy_configuration
|
protectedinherited |
◆ d_parent_integrator
|
protectedinherited |
◆ d_child_integrators
|
protectedinherited |
◆ d_visit_writer
|
protectedinherited |
◆ d_integrator_time
|
protectedinherited |
◆ d_start_time
|
protectedinherited |
◆ d_end_time
|
protectedinherited |
◆ d_dt_init
◆ d_dt_min
|
protectedinherited |
◆ d_dt_max
◆ d_dt_growth_factor
|
protectedinherited |
◆ d_integrator_step
|
protectedinherited |
◆ d_max_integrator_steps
|
protectedinherited |
◆ d_dt_previous
|
protectedinherited |
◆ d_num_cycles
|
protectedinherited |
◆ d_current_num_cycles
|
protectedinherited |
◆ d_current_cycle_num
|
protectedinherited |
◆ d_current_dt
|
protectedinherited |
◆ d_regrid_interval
|
protectedinherited |
◆ d_regrid_mode
|
protectedinherited |
◆ d_enable_logging
|
protectedinherited |
◆ d_enable_logging_solver_iterations
|
protectedinherited |
◆ d_bdry_extrap_type
|
protectedinherited |
◆ d_tag_buffer
|
protectedinherited |
◆ d_hier_math_ops
|
protectedinherited |
◆ d_manage_hier_math_ops
|
protectedinherited |
◆ d_state_variables
|
protectedinherited |
◆ d_scratch_variables
|
protectedinherited |
◆ d_copy_scratch_to_current_fast
|
protectedinherited |
◆ d_copy_scratch_to_current_slow
|
protectedinherited |
◆ d_current_data
|
protectedinherited |
◆ d_new_data
|
protectedinherited |
◆ d_scratch_data
|
protectedinherited |
◆ d_plot_data
|
protectedinherited |
◆ d_state_var_init_fcns
|
protectedinherited |
◆ d_current_context
|
protectedinherited |
Variable contexts.
◆ d_new_context
|
protectedinherited |
◆ d_scratch_context
|
protectedinherited |
◆ d_plot_context
|
protectedinherited |
◆ SYNCH_CURRENT_DATA_ALG
|
staticprotectedinherited |
Names of special coarsen algorithms/schedules.
◆ SYNCH_NEW_DATA_ALG
|
staticprotectedinherited |
◆ d_fill_after_regrid_bc_idxs
|
protectedinherited |
Regridding-related communications algorithms and other data structures.
◆ d_fill_after_regrid_prolong_alg
|
protectedinherited |
◆ d_fill_after_regrid_phys_bdry_bc_op
|
protectedinherited |
◆ d_preprocess_integrate_hierarchy_callbacks
|
protectedinherited |
Callback functions and callback function contexts.
◆ d_preprocess_integrate_hierarchy_callback_ctxs
|
protectedinherited |
◆ d_integrate_hierarchy_callbacks
|
protectedinherited |
◆ d_integrate_hierarchy_callback_ctxs
|
protectedinherited |
◆ d_postprocess_integrate_hierarchy_callbacks
|
protectedinherited |
◆ d_postprocess_integrate_hierarchy_callback_ctxs
|
protectedinherited |
◆ d_apply_gradient_detector_callbacks
|
protectedinherited |
◆ d_apply_gradient_detector_callback_ctxs
|
protectedinherited |
◆ d_regrid_hierarchy_callbacks
|
protectedinherited |
◆ d_regrid_hierarchy_callback_ctxs
|
protectedinherited |
◆ d_regridding_hierarchy
|
privateinherited |
◆ d_at_regrid_time_step
|
privateinherited |
◆ d_ghostfill_algs
|
privateinherited |
◆ d_ghostfill_strategies
|
privateinherited |
◆ d_ghostfill_scheds
|
privateinherited |
◆ d_prolong_algs
|
privateinherited |
◆ d_prolong_strategies
|
privateinherited |
◆ d_prolong_scheds
|
privateinherited |
◆ d_coarsen_algs
|
privateinherited |
◆ d_coarsen_strategies
|
privateinherited |
◆ d_coarsen_scheds
|
privateinherited |
The documentation for this class was generated from the following file:
- include/ibamr/AdvDiffHierarchyIntegrator.h
