Class INSVCStaggeredHierarchyIntegrator provides an abstract interface for time integrator for a staggered-grid, incompressible Navier-Stokes solver on an AMR grid hierarchy with variable coefficients. More...
#include <ibamr/INSVCStaggeredHierarchyIntegrator.h>
Public Types | |
| using | ResetFluidPropertiesFcnPtr = void(*)(int property_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > property_var, SAMRAI::tbox::Pointer< IBTK::HierarchyMathOps > hier_math_ops, int cycle_num, double time, double current_time, double new_time, void *ctx) |
| Function to reset fluid density or viscosity if they are maintained 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 | |
| INSVCStaggeredHierarchyIntegrator ()=delete | |
| Default constructor. More... | |
| INSVCStaggeredHierarchyIntegrator (const INSVCStaggeredHierarchyIntegrator &from)=delete | |
| Copy constructor. More... | |
| INSVCStaggeredHierarchyIntegrator & | operator= (const INSVCStaggeredHierarchyIntegrator &that)=delete |
| Assignment operator. More... | |
| void | preprocessOperatorsAndSolvers (double current_time, double new_time) |
| void | getFromInput (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db, bool is_from_restart) |
| void | getFromRestart () |
Detailed Description
An optional re-scaling factor c can be specified to minimize the loss of floating point precision for poorly scaling linear systems. The scaling acts on the momentum part of the saddle-point system, yielding \( c A + G(c x_p) = c b_u\) in which the viscous block, the pressure degrees of freedom, and the velocity RHS have been scaled.
Scaling \( c \) is chosen such that \( c(\frac{\rho}{dt} - \frac{\mu}{dx^2}) \sim \frac{1}{dx} \). The above scaling is chosen from the incompressiblity operator which scales as \( (\nabla \cdot) \sim \frac{1}{dx} \). Assuming \( dt \sim dx \) and \( 1/dx = N \), we have \( c \sim \frac{1}{\rho - \mu N} \). Here \( N \) is the number of cells for a unit length of the physical domain.
Different levels of patch hierarchy can have different scaling because of the difference in the grid spacing \( dx \). Therefore, an array of scale factors is read from the input file (corresponding to different levels). If the scale array does not contain values for all the levels in the hierarchy, it is filled by the most finest scaling factor provided by the user (for the missing finer levels).
Member Typedef Documentation
◆ ResetFluidPropertiesFcnPtr
| using IBAMR::INSVCStaggeredHierarchyIntegrator::ResetFluidPropertiesFcnPtr = void (*)(int property_idx, SAMRAI::tbox::Pointer<SAMRAI::hier::Variable<NDIM> > property_var, SAMRAI::tbox::Pointer<IBTK::HierarchyMathOps> hier_math_ops, int cycle_num, double time, double current_time, double new_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
◆ INSVCStaggeredHierarchyIntegrator() [1/3]
| IBAMR::INSVCStaggeredHierarchyIntegrator::INSVCStaggeredHierarchyIntegrator | ( | std::string | object_name, |
| SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > | input_db, | ||
| bool | register_for_restart = true |
||
| ) |
The constructor for class INSVCStaggeredHierarchyIntegrator sets some default values, reads in configuration information from input and restart databases, and registers the integrator object with the restart manager when requested.
◆ ~INSVCStaggeredHierarchyIntegrator()
| IBAMR::INSVCStaggeredHierarchyIntegrator::~INSVCStaggeredHierarchyIntegrator | ( | ) |
The destructor for class INSVCStaggeredHierarchyIntegrator unregisters the integrator object with the restart manager when the object is so registered.
◆ INSVCStaggeredHierarchyIntegrator() [2/3]
|
privatedelete |
- Note
- This constructor is not implemented and should not be used.
◆ INSVCStaggeredHierarchyIntegrator() [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
◆ getConvectiveOperator()
|
overridevirtual |
Get the convective operator being used by this solver class.
If the time integrator is configured to solve the time-dependent (creeping) Stokes equations, then the returned pointer will be nullptr.
If the convective operator has not already been constructed, and if the time integrator is not configured to solve the time-dependent (creeping) Stokes equations, then this function will initialize the default type of convective operator, which may be set in the class input database.
Implements IBAMR::INSHierarchyIntegrator.
◆ getVelocitySubdomainSolver()
|
overridevirtual |
Get the subdomain solver for the velocity subsystem. Such solvers can be useful in constructing block preconditioners.
Implements IBAMR::INSHierarchyIntegrator.
◆ getPressureSubdomainSolver()
|
overridevirtual |
Get the subdomain solver for the pressure subsystem. Such solvers can be useful in constructing block preconditioners.
Implements IBAMR::INSHierarchyIntegrator.
◆ setStokesSolver()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::setStokesSolver | ( | SAMRAI::tbox::Pointer< StaggeredStokesSolver > | stokes_solver | ) |
Register a solver for the time-dependent incompressible Stokes equations.
◆ getStokesSolver()
| SAMRAI::tbox::Pointer<StaggeredStokesSolver> IBAMR::INSVCStaggeredHierarchyIntegrator::getStokesSolver | ( | ) |
Get the solver for the time-dependent incompressible Stokes equations used by this solver class.
◆ setStokesSolverNeedsInit()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::setStokesSolverNeedsInit | ( | ) |
Indicate that the Stokes solver should be (re-)initialized before the next time step.
◆ initializeHierarchyIntegrator()
|
overridevirtual |
Virtual method to initialize the variables, basic communications algorithms, solvers, and other data structures used by a concrete 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::INSVCStaggeredNonConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredConservativeHierarchyIntegrator.
◆ initializePatchHierarchy()
|
overridevirtual |
Virtual method to 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 from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredConservativeHierarchyIntegrator.
◆ preprocessIntegrateHierarchy()
|
overridevirtual |
Virtual method to prepare to advance the data from current_time to new_time.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredConservativeHierarchyIntegrator.
◆ postprocessIntegrateHierarchy()
|
overridevirtual |
Virtual method to clean up data following call(s) to integrateHierarchy().
Reimplemented from IBAMR::INSHierarchyIntegrator.
Reimplemented in IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredConservativeHierarchyIntegrator.
◆ removeNullSpace()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::removeNullSpace | ( | const SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > > & | sol_vec | ) |
Explicitly remove nullspace components from a solution vector.
◆ registerMassDensityVariable()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::registerMassDensityVariable | ( | SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > | rho_var | ) |
Register a variable mass density variable with the hierarchy integrator.
◆ getMassDensityVariable()
| SAMRAI::tbox::Pointer<SAMRAI::hier::Variable<NDIM> > IBAMR::INSVCStaggeredHierarchyIntegrator::getMassDensityVariable | ( | ) | const |
Get the mass density variable registered with the hierarchy integrator.
◆ registerViscosityVariable()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::registerViscosityVariable | ( | SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > | mu_var | ) |
Register a variable viscosity variable with the hierarchy integrator.
◆ getViscosityVariable()
| SAMRAI::tbox::Pointer<SAMRAI::hier::Variable<NDIM> > IBAMR::INSVCStaggeredHierarchyIntegrator::getViscosityVariable | ( | ) | const |
Get the viscosity variable registered with the hierarchy integrator.
◆ setDensityVCInterpolationType()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::setDensityVCInterpolationType | ( | const IBTK::VCInterpType | vc_interp_type | ) |
Set the interpolation type used for material properties rho
◆ setViscosityVCInterpolationType()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::setViscosityVCInterpolationType | ( | const IBTK::VCInterpType | vc_interp_type | ) |
Set the interpolation type used for material properties mu
◆ registerResetFluidDensityFcn()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::registerResetFluidDensityFcn | ( | ResetFluidPropertiesFcnPtr | callback, |
| void * | ctx | ||
| ) |
◆ registerResetFluidViscosityFcn()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::registerResetFluidViscosityFcn | ( | ResetFluidPropertiesFcnPtr | callback, |
| void * | ctx | ||
| ) |
◆ registerBrinkmanPenalizationStrategy()
|
virtual |
◆ registerMassDensityInitialConditions()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::registerMassDensityInitialConditions | ( | SAMRAI::tbox::Pointer< IBTK::CartGridFunction > | rho_init_fcn | ) |
◆ registerViscosityInitialConditions()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::registerViscosityInitialConditions | ( | SAMRAI::tbox::Pointer< IBTK::CartGridFunction > | mu_init_fcn | ) |
◆ registerMassDensityBoundaryConditions()
|
pure virtual |
◆ registerViscosityBoundaryConditions()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::registerViscosityBoundaryConditions | ( | SAMRAI::solv::RobinBcCoefStrategy< NDIM > * | mu_bc_coef | ) |
◆ setTransportedViscosityVariable()
| void IBAMR::INSVCStaggeredHierarchyIntegrator::setTransportedViscosityVariable | ( | SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > | mu_adv_diff_var, |
| unsigned int | adv_diff_idx = 0 |
||
| ) |
◆ getTransportedViscosityVariable()
| SAMRAI::tbox::Pointer<SAMRAI::pdat::CellVariable<NDIM, double> > IBAMR::INSVCStaggeredHierarchyIntegrator::getTransportedViscosityVariable | ( | ) | const |
◆ getLinearOperatorRhoPatchDataIndex()
|
inline |
- Note
- These patch data will not be deallocated at the end of the time step, so they can be used for various applications
◆ rhoIsConstant()
|
inline |
◆ muIsConstant()
|
inline |
◆ getLinearOperatorMuPatchDataIndex()
|
inline |
- Note
- These patch data will not be deallocated at the end of the time step, so they can be used for various applications
◆ getInterpolatedLinearOperatorMuPatchDataIndex()
|
inline |
- Note
- These patch data will not be deallocated at the end of the time step, so they can be used for various applications
◆ getScalingFactor()
|
inline |
◆ getViscosityBoundaryConditions()
|
inline |
◆ getBrinkmanPenalizationStrategy()
|
inline |
◆ getOldVelocityVariable()
|
inline |
◆ getStableTimestep() [1/2]
|
overrideprotectedvirtual |
Determine the largest stable timestep on an individual patch.
Implements IBAMR::INSHierarchyIntegrator.
◆ regridHierarchyBeginSpecialized()
|
overrideprotectedvirtual |
Prepare the current hierarchy for regridding. Here we calculate the divergence.
Reimplemented from IBTK::HierarchyIntegrator.
◆ regridHierarchyEndSpecialized()
|
overrideprotectedvirtual |
Update the current hierarchy data after regridding. Here we recalculate the divergence and, if it has grown by a factor more than d_regrid_max_div_growth_factor, we then project the velocity field onto a divergence-free set of grid functions.
Reimplemented from IBTK::HierarchyIntegrator.
◆ initializeCompositeHierarchyDataSpecialized()
|
overrideprotectedvirtual |
Perform data initialization after the entire hierarchy has been constructed.
- Note
- If \( \nabla \cdot \mathbf{u} = Q \) is specified, then at the initial time the velocity projection step is omitted in this routine. This is because \( Q \) generally involves derivatives of transported variables, which are not known at the initial time. More concretely, imagine we are simulating a phase change or combustion process. The volume change effect \( \nabla \cdot \mathbf{u} \) that is captured by \( Q \) would be computed through gradients of temperature or species concentration. These gradients are not known at the initial time. These volume change causing processes gradually evolve during the simulation, which builds up \( Q \) over time. The best thing to do at \( t = 0 \), is not do anything. This tantamounts to assuming \( Q = 0 \) initially, which would almost certainly be the case in these types of simulations. For example, one would not simulate a combustion process starting from a point where some stuff has already been combusted. If that were the case, then it is already known what species have been generated/consumed at an arbitrary time $t$. In other words, the whole solution is known for the problem.
Reimplemented from IBTK::HierarchyIntegrator.
◆ initializeLevelDataSpecialized()
|
overrideprotectedvirtual |
Virtual method to initialize data on a new level after it is inserted into an AMR patch hierarchy by the gridding algorithm.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator.
◆ resetHierarchyConfigurationSpecialized()
|
overrideprotectedvirtual |
Virtual method to reset cached hierarchy dependent data.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator.
◆ applyGradientDetectorSpecialized()
|
overrideprotectedvirtual |
Virtual method to set integer tags to "one" in cells where refinement of the given level should occur according to the magnitude of the fluid vorticity.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator.
◆ setupPlotDataSpecialized()
|
overrideprotectedvirtual |
Virtual method to prepare variables for plotting.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator.
◆ copySideToFace()
|
protected |
Copy data from a side-centered variable to a face-centered variable.
◆ 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.
◆ preprocessOperatorsAndSolvers()
|
private |
Preprocess the operators and solvers used by the hierarchy integrator.
◆ setViscousTimeSteppingType()
|
inherited |
Set the type of viscous time integration scheme being employed by the incompressible flow solver.
Different implementations may support different time stepping schemes.
◆ getViscousTimeSteppingType()
|
inherited |
Get the type of viscous time integration scheme being employed by the incompressible flow solver.
Different implementations may support different time stepping schemes.
◆ setConvectiveTimeSteppingType()
|
inherited |
Set the type of convective time integration scheme being employed by the incompressible flow solver.
Different implementations may support different time stepping schemes.
◆ getConvectiveTimeSteppingType()
|
inherited |
Get the type of convective time integration scheme being employed by the incompressible flow solver.
Different implementations may support different time stepping schemes.
◆ setInitialConvectiveTimeSteppingType()
|
inherited |
Set the type of convective time integration scheme being employed by the incompressible flow solver during the initial time step.
Different implementations may support different time stepping schemes.
- Note
- This is used only when the basic convective time stepping scheme uses a multi-step method such as Adams-Bashforth.
◆ getInitialConvectiveTimeSteppingType()
|
inherited |
Get the type of convective time integration scheme being employed by the incompressible flow solver during the initial time step.
Different implementations may support different time stepping schemes.
- Note
- This is used only when the basic convective time stepping scheme uses a multi-step method such as Adams-Bashforth.
◆ registerAdvDiffHierarchyIntegrator()
|
inherited |
Register an advection-diffusion solver with this incompressible Navier-Stokes solver.
◆ setStokesSpecifications()
|
inherited |
Set the problem coefficients used by the solver.
◆ getStokesSpecifications()
|
inherited |
Get a const pointer to the problem coefficients object used by the solver.
◆ registerPhysicalBoundaryConditions()
|
inherited |
Supply a physical boundary conditions specificaion for the velocity field. Boundary conditions take the form of \( a\mathbf{u} + b\tau\cdot\mathbf{n} = \mathbf{g}\) where \(\tau = -p\mathbf{I} + \frac{\mu}{2}\left(\nabla\mathbf{u} + \nabla\mathbf{u}^T\right)\) is the Newtonian fluid stress and \(\mu\) is the fluid viscosity.
- Note
- Periodic boundaries take presidence over physical boundaries. The type of boundary can be adjusted through the
CartesianGeometrydatabase in the input file, specifically with the flagperiodic_dimension. - Current implementations of physical boundary conditions require that at any physical location the values of \( a\) and \( b \) stasify that either \( a = 1 \) or \(b = 1\) as well as \(a + b = 1\). An error will occur if this does not happen.
- See also
- IBTK::muParserRobinBcCoefs
◆ getVelocityBoundaryConditions()
|
virtualinherited |
Get a vector of pointers to the velocity boundary condition specification objects.
- Note
- Implementations may return a vector of nullptr pointers.
◆ getPressureBoundaryConditions()
|
virtualinherited |
Get a pointer to the pressure boundary condition specification object.
- Note
- Implementations may return a nullptr pointer.
◆ registerVelocityInitialConditions()
|
inherited |
Supply initial conditions for the velocity field.
◆ registerPressureInitialConditions()
|
inherited |
Supply initial conditions for the pressure.
- Note
- Initial conditions are not required for the pressure, but when available, they can speed the convergence of the solver during the initial time step.
◆ registerBodyForceFunction()
|
inherited |
Supply a body force.
◆ registerFluidSourceFunction()
|
inherited |
Supply a fluid source/sink distribution.
- Deprecated:
- Use registerVelocityDivergenceFunction() instead.
◆ registerVelocityDivergenceFunction()
|
inherited |
Supply a CartGridFunction that specifies \( \nabla \cdot \mathbf{u} \).
- Note
- If
- Parameters
-
Q_fcn is not specified, then \( \nabla \cdot \mathbf{u} = 0 \) is imposed.
◆ getVelocityVariable()
|
inherited |
Return a pointer to the fluid velocity variable.
◆ getPressureVariable()
|
inherited |
Return a pointer to the fluid pressure state variable.
◆ getBodyForceVariable()
|
inherited |
Return a pointer to the body force variable.
◆ getFluidSourceVariable()
|
inherited |
Return a pointer to the source strength variable.
- Deprecated:
- Use getVelocityDivergenceVariable() instead.
◆ getVelocityDivergenceVariable()
|
inherited |
Return a pointer to the variable that specifies the divergence of the velocity.
◆ getAdvectionVelocityVariable()
|
inherited |
Return a pointer to a fluid velocity variable that can be used to advect quantities registered with an advection-diffusion solver.
Data are allocated for this variable using the current context. Patch data for this variable are allocated only when an advection-diffusion solver is registered with the Navier-Stokes solver.
◆ getIntermediateVelocityBoundaryConditions()
|
inherited |
Get a vector of pointers to the intermediate velocity boundary condition specification objects.
◆ getProjectionBoundaryConditions()
|
inherited |
Get a pointer to the projection Poisson problem boundary condition specification object.
◆ setConvectiveOperatorType()
|
inherited |
◆ getConvectiveOperatorType()
|
inherited |
◆ setConvectiveDifferencingType()
|
inherited |
◆ getConvectiveDifferencingType()
|
inherited |
◆ setCreepingFlow()
|
inherited |
◆ getCreepingFlow()
|
inherited |
◆ setConvectiveOperator()
|
inherited |
Register an operator to compute the convective acceleration term u*grad u.
If the supplied operator is nullptr, then the integrator will solve the time-dependent (creeping) Stokes equations instead of the Navier-Stokes equations.
◆ setConvectiveOperatorNeedsInit()
|
inherited |
Indicate that the convective operator should be (re-)initialized before the next time step.
◆ setVelocitySubdomainSolver()
|
inherited |
Register a solver for the velocity subsystem.
◆ setVelocitySubdomainSolverNeedsInit()
|
inherited |
Indicate that the velocity subdomain solver should be (re-)initialized before the next time step.
◆ setPressureSubdomainSolver()
|
inherited |
Register a solver for the pressure subsystem.
◆ setPressureSubdomainSolverNeedsInit()
|
inherited |
Indicate that the velocity subdomain solver should be (re-)initialized before the next time step.
◆ getNumberOfCycles()
|
overridevirtualinherited |
Returns the number of cycles to perform for the present time step.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::INSVCStaggeredConservativeHierarchyIntegrator.
◆ getCurrentCFLNumber()
|
virtualinherited |
Return the current CFL number (i.e., the CFL number computed from the current velocity field). This is typically computed at the end of each time step.
◆ regridProjection()
|
protectedpure virtualinherited |
Pure virtual method to project the velocity field following a regridding operation.
Implemented in IBAMR::INSStaggeredHierarchyIntegrator, IBAMR::INSCollocatedHierarchyIntegrator, IBAMR::INSVCStaggeredConservativeHierarchyIntegrator, and IBAMR::INSVCStaggeredNonConservativeHierarchyIntegrator.
◆ updateCurrentCFLNumber()
|
protectedvirtualinherited |
Update the current CFL number (i.e., at the end of a timestep).
- Note
- this method can handle both cell-centered and side-centered velocities.
◆ getMaximumVorticityMagnitude()
|
protectedinherited |
Compute the maximum vorticity magnitude at any given point.
- Note
- This function does not read ghost data from
Omega_idx.
◆ tagCellsByVorticityMagnitude()
|
protectedinherited |
Tag cells based on the vorticity magnitude.
- Note
- This function is typically called by applyGradientDetectorSpecialized() in inheriting classes.
◆ getMaximumTimeStepSizeSpecialized()
|
overrideprotectedvirtualinherited |
Return the maximum stable time step size.
Reimplemented from IBTK::HierarchyIntegrator.
◆ getStableTimestep() [2/2]
|
protectedinherited |
Determine the largest stable timestep on an individual patch level.
◆ putToDatabaseSpecialized()
|
overrideprotectedvirtualinherited |
Write out specialized object state to the given database.
Reimplemented from IBTK::HierarchyIntegrator.
Reimplemented in IBAMR::INSStaggeredHierarchyIntegrator.
◆ getFromInput()
|
privateinherited |
Read input values from a given database.
◆ getFromRestart()
|
privateinherited |
Read object state from the restart file and initialize class data members.
◆ getName()
|
inherited |
Return the name of the hierarchy integrator object.
◆ 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.
◆ 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).
◆ 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.
◆ 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.
◆ 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_div_U_norm_1_pre
|
protected |
L1 norm of the discrete divergence of the fluid velocity before regridding.
◆ d_div_U_norm_2_pre
|
protected |
L2 norm of the discrete divergence of the fluid velocity before regridding.
◆ d_div_U_norm_oo_pre
|
protected |
L-infinity norm of the discrete divergence of the fluid velocity before regridding.
◆ d_div_U_norm_1_post
|
protected |
L1 norm of the discrete divergence of the fluid velocity after regridding.
◆ d_div_U_norm_2_post
|
protected |
L2 norm of the discrete divergence of the fluid velocity after regridding.
◆ d_div_U_norm_oo_post
|
protected |
L-infinity norm of the discrete divergence of the fluid velocity after regridding.
◆ d_do_regrid_projection
|
protected |
Whether we need to perform a regrid projection when (re-)initializing composite hierarchy data.
◆ d_hier_cc_data_ops
|
protected |
Hierarchy operations objects.
◆ d_hier_fc_data_ops
|
protected |
◆ d_hier_sc_data_ops
|
protected |
◆ d_hier_nc_data_ops
|
protected |
◆ d_hier_ec_data_ops
|
protected |
◆ d_bc_helper
|
protected |
◆ d_side_synch_op
|
protected |
◆ d_rho_bdry_bc_fill_op
|
protected |
◆ d_mu_bdry_bc_fill_op
|
protected |
◆ d_rho_scale
|
protected |
Double precision values are (optional) factors used to rescale the density and viscosity for plotting.
Boolean values indicates whether to output various quantities for visualization.
◆ d_mu_scale
|
protected |
◆ d_output_rho
|
protected |
◆ d_output_mu
|
protected |
◆ d_coarsest_reset_ln
|
protected |
◆ d_finest_reset_ln
|
protected |
◆ d_U_scratch_vec
|
protected |
◆ d_U_rhs_vec
|
protected |
◆ d_U_adv_vec
|
protected |
◆ d_N_vec
|
protected |
◆ d_P_scratch_vec
|
protected |
◆ d_P_rhs_vec
|
protected |
◆ d_sol_vec
|
protected |
◆ d_rhs_vec
|
protected |
◆ d_nul_vecs
|
protected |
◆ d_U_nul_vecs
|
protected |
◆ d_vectors_need_init
|
protected |
◆ d_explicitly_remove_nullspace
|
protected |
◆ d_stokes_solver_type
|
protected |
◆ d_stokes_precond_type
|
protected |
◆ d_stokes_solver_db
|
protected |
◆ d_stokes_precond_db
|
protected |
◆ d_stokes_solver
|
protected |
◆ d_stokes_solver_needs_init
|
protected |
◆ d_U_var
|
protected |
Fluid solver variables.
◆ d_U_old_var
|
protected |
◆ d_U_cc_var
|
protected |
◆ d_P_var
|
protected |
◆ d_F_var
|
protected |
◆ d_F_cc_var
|
protected |
◆ d_N_old_var
|
protected |
◆ d_Omega_var
|
protected |
◆ d_Div_U_var
|
protected |
◆ d_U_regrid_var
|
protected |
◆ d_U_src_var
|
protected |
◆ d_indicator_var
|
protected |
◆ d_F_div_var
|
protected |
◆ d_Q_var
|
protected |
◆ d_EE_var
|
protected |
◆ d_rho_var
|
protected |
◆ d_mu_var
|
protected |
◆ d_pressure_D_var
|
protected |
◆ d_pressure_rhs_D_var
|
protected |
◆ d_velocity_D_cc_var
|
protected |
◆ d_velocity_C_var
|
protected |
◆ d_velocity_L_var
|
protected |
◆ d_velocity_rhs_C_var
|
protected |
◆ d_N_full_var
|
protected |
◆ d_N_coarsen_type
|
protected |
◆ d_N_refine_type
|
protected |
◆ d_mu_coarsen_type
|
protected |
◆ d_mu_refine_type
|
protected |
◆ d_mu_bdry_extrap_type
|
protected |
◆ d_rho_coarsen_type
|
protected |
◆ d_rho_refine_type
|
protected |
◆ d_rho_bdry_extrap_type
|
protected |
◆ d_reset_rho_fcns
|
protected |
Interpolated material property variables.
Functions resetting rho and mu if they are maintained by this integrator.
◆ d_reset_mu_fcns
|
protected |
◆ d_reset_rho_fcns_ctx
|
protected |
◆ d_reset_mu_fcns_ctx
|
protected |
◆ d_brinkman_force
|
protected |
Brinkman force strategy objects registered with this integrator.
◆ d_temp_sc_var
|
protected |
Temporary storage variables that contain intermediate quantities
◆ d_temp_sc_idx
|
protected |
◆ d_temp_cc_var
|
protected |
◆ d_temp_cc_idx
|
protected |
◆ d_U_current_idx
|
protected |
◆ d_U_new_idx
|
protected |
◆ d_U_scratch_idx
|
protected |
◆ d_U_old_current_idx
|
protected |
◆ d_U_old_new_idx
|
protected |
◆ d_U_old_scratch_idx
|
protected |
◆ d_P_current_idx
|
protected |
◆ d_P_new_idx
|
protected |
◆ d_P_scratch_idx
|
protected |
◆ d_F_current_idx
|
protected |
◆ d_F_new_idx
|
protected |
◆ d_F_scratch_idx
|
protected |
◆ d_Q_current_idx
|
protected |
◆ d_Q_new_idx
|
protected |
◆ d_Q_scratch_idx
|
protected |
◆ d_N_old_current_idx
|
protected |
◆ d_N_old_new_idx
|
protected |
◆ d_N_old_scratch_idx
|
protected |
◆ d_mu_current_idx
|
protected |
◆ d_mu_new_idx
|
protected |
◆ d_mu_scratch_idx
|
protected |
◆ d_U_cc_idx
|
protected |
◆ d_F_cc_idx
|
protected |
◆ d_Omega_idx
|
protected |
◆ d_Div_U_idx
|
protected |
◆ d_EE_idx
|
protected |
◆ d_U_regrid_idx
|
protected |
◆ d_U_src_idx
|
protected |
◆ d_indicator_idx
|
protected |
◆ d_F_div_idx
|
protected |
◆ d_velocity_C_idx
|
protected |
◆ d_velocity_L_idx
|
protected |
◆ d_velocity_D_idx
|
protected |
◆ d_velocity_D_cc_idx
|
protected |
◆ d_pressure_D_idx
|
protected |
◆ d_velocity_rhs_C_idx
|
protected |
◆ d_velocity_rhs_D_idx
|
protected |
◆ d_pressure_rhs_D_idx
|
protected |
◆ d_mu_interp_idx
|
protected |
◆ d_N_full_idx
|
protected |
◆ d_mu_linear_op_idx
|
protected |
◆ d_mu_interp_linear_op_idx
|
protected |
◆ d_rho_linear_op_idx
|
protected |
◆ d_rho_is_const
|
protected |
◆ d_mu_is_const
|
protected |
◆ d_rho_vc_interp_type
|
protected |
◆ d_mu_vc_interp_type
|
protected |
◆ d_A_scale
|
protected |
◆ d_precond_reinit_interval
|
protected |
◆ d_rho_init_fcn
|
protected |
◆ d_mu_init_fcn
|
protected |
◆ d_mu_bc_coef
|
protected |
◆ d_mu_adv_diff_var
|
protected |
◆ d_mu_adv_diff_idx
|
protected |
◆ d_integrator_is_initialized
|
protectedinherited |
◆ d_viscous_time_stepping_type
|
protectedinherited |
Enum indicating the time integration employed for the implicit discretization of the viscous terms.
◆ d_convective_time_stepping_type
|
protectedinherited |
Enum indicating the time integration employed for the explicit discretization of the convective terms.
◆ d_init_convective_time_stepping_type
|
protectedinherited |
Enum indicating the time integration employed for the explicit discretization of the convective terms during the initial time step.
◆ d_problem_coefs
|
protectedinherited |
Problem coeficients.
◆ d_adv_diff_hier_integrators
|
protectedinherited |
◆ d_U_adv_diff_var
|
protectedinherited |
◆ d_cfl_current
|
protectedinherited |
Current CFL number.
◆ d_cfl_max
|
protectedinherited |
The maximum CFL number.
◆ d_using_vorticity_tagging
|
protectedinherited |
Cell tagging criteria based on the relative and absolute magnitudes of the local vorticity.
◆ d_Omega_rel_thresh
|
protectedinherited |
◆ d_Omega_abs_thresh
|
protectedinherited |
◆ d_normalize_pressure
|
protectedinherited |
This boolean value determines whether the pressure is normalized to have zero mean (i.e., discrete integral) at the end of each timestep.
◆ d_normalize_velocity
|
protectedinherited |
This boolean value determines whether the velocity is normalized to have zero mean (i.e., discrete integral) at the end of each timestep.
This parameter only affects the case in which rho=0 (i.e. the steady Stokes equations).
◆ d_creeping_flow
|
protectedinherited |
This boolean value determines whether the convective acceleration term is included in the momentum equation. (If it is not, this solver effectively solves the so-called creeping Stokes equations.)
◆ d_regrid_max_div_growth_factor
|
protectedinherited |
Threshold that determines whether the velocity field needs to be reprojected following adaptive regridding.
◆ d_U_scale
|
protectedinherited |
Double precision values are (optional) factors used to rescale the velocity, pressure, and force for plotting.
Boolean values indicates whether to output various quantities for visualization.
◆ d_P_scale
|
protectedinherited |
◆ d_F_scale
|
protectedinherited |
◆ d_Q_scale
|
protectedinherited |
◆ d_Omega_scale
|
protectedinherited |
◆ d_Div_U_scale
|
protectedinherited |
◆ d_EE_scale
|
protectedinherited |
◆ d_output_U
|
protectedinherited |
◆ d_output_P
|
protectedinherited |
◆ d_output_F
|
protectedinherited |
◆ d_output_Q
|
protectedinherited |
◆ d_output_Omega
|
protectedinherited |
◆ d_output_Div_U
|
protectedinherited |
◆ d_output_EE
|
protectedinherited |
◆ d_U_coarsen_type
|
protectedinherited |
◆ d_U_refine_type
|
protectedinherited |
◆ d_P_coarsen_type
|
protectedinherited |
◆ d_P_refine_type
|
protectedinherited |
◆ d_F_coarsen_type
|
protectedinherited |
◆ d_F_refine_type
|
protectedinherited |
◆ d_Q_coarsen_type
|
protectedinherited |
◆ d_Q_refine_type
|
protectedinherited |
◆ d_U_init
|
protectedinherited |
Objects to set initial conditions, boundary conditions, body forces, and fluid source/sink distributions.
◆ d_P_init
|
protectedinherited |
◆ d_default_bc_coefs
|
protectedinherited |
◆ d_bc_coefs
|
protectedinherited |
◆ d_U_bc_coefs
|
protectedinherited |
◆ d_U_star_bc_coefs
|
protectedinherited |
◆ d_traction_bc_type
|
protectedinherited |
◆ d_P_bc_coef
|
protectedinherited |
◆ d_Phi_bc_coef
|
protectedinherited |
◆ d_F_fcn
|
protectedinherited |
◆ d_Q_fcn
|
protectedinherited |
◆ d_U_bdry_bc_fill_op
|
protectedinherited |
◆ d_P_bdry_bc_fill_op
|
protectedinherited |
◆ d_Q_bdry_bc_fill_op
|
protectedinherited |
◆ d_no_fill_op
|
protectedinherited |
◆ d_use_div_sink_drag_term
|
protectedinherited |
◆ d_convective_op_type
|
protectedinherited |
◆ d_convective_difference_form
|
protectedinherited |
◆ d_convective_op_input_db
|
protectedinherited |
◆ d_convective_op
|
protectedinherited |
◆ d_convective_op_needs_init
|
protectedinherited |
◆ d_velocity_solver_type
|
protectedinherited |
◆ d_velocity_precond_type
|
protectedinherited |
◆ d_velocity_sub_precond_type
|
protectedinherited |
◆ d_velocity_solver_db
|
protectedinherited |
◆ d_velocity_precond_db
|
protectedinherited |
◆ d_velocity_sub_precond_db
|
protectedinherited |
◆ d_velocity_solver
|
protectedinherited |
◆ d_velocity_solver_needs_init
|
protectedinherited |
◆ d_pressure_solver_type
|
protectedinherited |
◆ d_pressure_precond_type
|
protectedinherited |
◆ d_pressure_sub_precond_type
|
protectedinherited |
◆ d_pressure_solver_db
|
protectedinherited |
◆ d_pressure_precond_db
|
protectedinherited |
◆ d_pressure_sub_precond_db
|
protectedinherited |
◆ d_pressure_solver
|
protectedinherited |
◆ d_pressure_solver_needs_init
|
protectedinherited |
◆ d_regrid_projection_solver_type
|
protectedinherited |
◆ d_regrid_projection_precond_type
|
protectedinherited |
◆ d_regrid_projection_sub_precond_type
|
protectedinherited |
◆ d_regrid_projection_solver_db
|
protectedinherited |
◆ d_regrid_projection_precond_db
|
protectedinherited |
◆ d_regrid_projection_sub_precond_db
|
protectedinherited |
◆ 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/INSVCStaggeredHierarchyIntegrator.h
