Class IBStrategySet is a utility class that allows multiple IBStrategy objects to be employed by a single IBHierarchyIntegrator.

#include <ibamr/IBStrategySet.h>

Inheritance diagram for IBAMR::IBStrategySet:

[legend]

Public Member Functions
template<typename InputIterator >
	IBStrategySet (InputIterator first, InputIterator last)
	Constructor. More...

void	registerIBHierarchyIntegrator (IBHierarchyIntegrator *ib_solver) override

void	registerEulerianVariables () override

void	registerEulerianCommunicationAlgorithms () override

const SAMRAI::hier::IntVector< NDIM > &	getMinimumGhostCellWidth () const override

void	setupTagBuffer (SAMRAI::tbox::Array< int > &tag_buffer, SAMRAI::tbox::Pointer< SAMRAI::mesh::GriddingAlgorithm< NDIM > > gridding_alg) const override

virtual double	getMaxPointDisplacement () const override

void	preprocessIntegrateData (double current_time, double new_time, int num_cycles) override

void	postprocessIntegrateData (double current_time, double new_time, int num_cycles) override

void	updateFixedLEOperators () override

void	interpolateVelocity (int u_data_idx, const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenSchedule< NDIM > > > &u_synch_scheds, const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &u_ghost_fill_scheds, double data_time) override

void	forwardEulerStep (double current_time, double new_time) override

void	midpointStep (double current_time, double new_time) override

void	trapezoidalStep (double current_time, double new_time) override

void	computeLagrangianForce (double data_time) override

void	spreadForce (int f_data_idx, IBTK::RobinPhysBdryPatchStrategy *f_phys_bdry_op, const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &f_prolongation_scheds, double data_time) override

bool	hasFluidSources () const override

void	computeLagrangianFluidSource (double data_time) override

void	spreadFluidSource (int q_data_idx, IBTK::RobinPhysBdryPatchStrategy *q_phys_bdry_op, const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &q_prolongation_scheds, double data_time) override

void	interpolatePressure (int p_data_idx, const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenSchedule< NDIM > > > &p_synch_scheds, const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &p_ghost_fill_scheds, double data_time) override

void	preprocessSolveFluidEquations (double current_time, double new_time, int cycle_num) override

void	postprocessSolveFluidEquations (double current_time, double new_time, int cycle_num) override

void	postprocessData () override

void	initializePatchHierarchy (SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, SAMRAI::tbox::Pointer< SAMRAI::mesh::GriddingAlgorithm< NDIM > > gridding_alg, int u_data_idx, const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenSchedule< NDIM > > > &u_synch_scheds, const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &u_ghost_fill_scheds, int integrator_step, double init_data_time, bool initial_time) override

void	registerLoadBalancer (SAMRAI::tbox::Pointer< SAMRAI::mesh::LoadBalancer< NDIM > > load_balancer, int workload_data_idx) override

void	addWorkloadEstimate (SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, const int workload_data_idx) override

void	beginDataRedistribution (SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, SAMRAI::tbox::Pointer< SAMRAI::mesh::GriddingAlgorithm< NDIM > > gridding_alg) override

void	endDataRedistribution (SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, SAMRAI::tbox::Pointer< SAMRAI::mesh::GriddingAlgorithm< NDIM > > gridding_alg) override

void	initializeLevelData (SAMRAI::tbox::Pointer< SAMRAI::hier::BasePatchHierarchy< NDIM > > hierarchy, int level_number, double init_data_time, bool can_be_refined, bool initial_time, SAMRAI::tbox::Pointer< SAMRAI::hier::BasePatchLevel< NDIM > > old_level, bool allocate_data) override

void	resetHierarchyConfiguration (SAMRAI::tbox::Pointer< SAMRAI::hier::BasePatchHierarchy< NDIM > > hierarchy, int coarsest_level, int finest_level) override

void	applyGradientDetector (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) override

void	putToDatabase (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db) override

virtual void	inactivateLagrangianStructure (int structure_number=0, int level_number=std::numeric_limits< int >::max())

virtual void	activateLagrangianStructure (int structure_number=0, int level_number=std::numeric_limits< int >::max())

virtual bool	getLagrangianStructureIsActivated (int structure_number=0, int level_number=std::numeric_limits< int >::max()) const

void	setUseFixedLEOperators (bool use_fixed_coupling_ops=true)

virtual void	setUseMultistepTimeStepping (unsigned int n_previous_steps=1)

virtual void	backwardEulerStep (double current_time, double new_time)

virtual void	AB2Step (double current_time, double new_time)

virtual void	initializeLevelData (const tbox::Pointer< hier::BasePatchHierarchy< DIM > > hierarchy, const int level_number, const double init_data_time, const bool can_be_refined, const bool initial_time, const tbox::Pointer< hier::BasePatchLevel< DIM > > old_level=tbox::Pointer< hier::BasePatchLevel< DIM > >(NULL), const bool allocate_data=true)=0

virtual void	resetHierarchyConfiguration (const tbox::Pointer< hier::BasePatchHierarchy< DIM > > hierarchy, const int coarsest_level, const int finest_level)=0

virtual void	applyGradientDetector (const tbox::Pointer< hier::BasePatchHierarchy< DIM > > hierarchy, const int level_number, const double error_data_time, const int tag_index, const bool initial_time, const bool uses_richardson_extrapolation_too)

virtual double	getLevelDt (const tbox::Pointer< hier::BasePatchLevel< DIM > > level, const double dt_time, const bool initial_time)

virtual double	advanceLevel (const tbox::Pointer< hier::BasePatchLevel< DIM > > level, const tbox::Pointer< hier::BasePatchHierarchy< DIM > > hierarchy, const double current_time, const double new_time, const bool first_step, const bool last_step, const bool regrid_advance=false)

virtual void	resetTimeDependentData (const tbox::Pointer< hier::BasePatchLevel< DIM > > level, const double new_time, const bool can_be_refined)

virtual void	resetDataToPreadvanceState (const tbox::Pointer< hier::BasePatchLevel< DIM > > level)

virtual void	applyRichardsonExtrapolation (const tbox::Pointer< hier::PatchLevel< DIM > > level, const double error_data_time, const int tag_index, const double deltat, const int error_coarsen_ratio, const bool initial_time, const bool uses_gradient_detector_too)

virtual void	coarsenDataForRichardsonExtrapolation (const tbox::Pointer< hier::PatchHierarchy< DIM > > hierarchy, const int level_number, const tbox::Pointer< hier::PatchLevel< DIM > > coarser_level, const double coarsen_data_time, const bool before_advance)

Protected Member Functions
INSHierarchyIntegrator *	getINSHierarchyIntegrator () const

SAMRAI::tbox::Pointer< SAMRAI::math::HierarchyDataOpsReal< NDIM, double > >	getVelocityHierarchyDataOps () const

SAMRAI::tbox::Pointer< SAMRAI::math::HierarchyDataOpsReal< NDIM, double > >	getPressureHierarchyDataOps () const

SAMRAI::tbox::Pointer< IBTK::HierarchyMathOps >	getHierarchyMathOps () const

void	registerVariable (int &current_idx, int &new_idx, int &scratch_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > variable, const SAMRAI::hier::IntVector< NDIM > &scratch_ghosts=SAMRAI::hier::IntVector< NDIM >(0), const std::string &coarsen_name="NO_COARSEN", const std::string &refine_name="NO_REFINE", SAMRAI::tbox::Pointer< IBTK::CartGridFunction > init_fcn=nullptr, const bool register_for_restart=true)

void	registerVariable (int &idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > variable, const SAMRAI::hier::IntVector< NDIM > &ghosts=SAMRAI::hier::IntVector< NDIM >(0), SAMRAI::tbox::Pointer< SAMRAI::hier::VariableContext > ctx=SAMRAI::tbox::Pointer< SAMRAI::hier::VariableContext >(nullptr), const bool register_for_restart=true)

void	registerGhostfillRefineAlgorithm (const std::string &name, SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineAlgorithm< NDIM > > ghostfill_alg, std::unique_ptr< SAMRAI::xfer::RefinePatchStrategy< NDIM > > ghostfill_patch_strategy=nullptr)

void	registerProlongRefineAlgorithm (const std::string &name, SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineAlgorithm< NDIM > > prolong_alg, std::unique_ptr< SAMRAI::xfer::RefinePatchStrategy< NDIM > > prolong_patch_strategy=nullptr)

void	registerCoarsenAlgorithm (const std::string &name, SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenAlgorithm< NDIM > > coarsen_alg, std::unique_ptr< SAMRAI::xfer::CoarsenPatchStrategy< NDIM > > coarsen_patch_strategy=nullptr)

SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineAlgorithm< NDIM > >	getGhostfillRefineAlgorithm (const std::string &name) const

SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineAlgorithm< NDIM > >	getProlongRefineAlgorithm (const std::string &name) const

SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenAlgorithm< NDIM > >	getCoarsenAlgorithm (const std::string &name) const

const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &	getGhostfillRefineSchedules (const std::string &name) const

const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &	getProlongRefineSchedules (const std::string &name) const

const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenSchedule< NDIM > > > &	getCoarsenSchedules (const std::string &name) const

Protected Attributes
IBHierarchyIntegrator *	d_ib_solver = nullptr

bool	d_use_fixed_coupling_ops = false

Private Member Functions
	IBStrategySet (const IBStrategySet &from)=delete
	Copy constructor. More...

IBStrategySet &	operator= (const IBStrategySet &that)=delete
	Assignment operator. More...

Private Attributes
std::vector< SAMRAI::tbox::Pointer< IBStrategy > >	d_strategy_set
	The set of IBStrategy objects. More...

Constructor & Destructor Documentation

◆ IBStrategySet() [1/2]

template<typename InputIterator >

IBAMR::IBStrategySet::IBStrategySet	(	InputIterator	first,
		InputIterator	last
	)

inline

◆ IBStrategySet() [2/2]

IBAMR::IBStrategySet::IBStrategySet ( const IBStrategySet & from )

privatedelete

Note: This constructor is not implemented and should not be used.

Parameters

from	The value to copy to this object.

Member Function Documentation

◆ registerIBHierarchyIntegrator()

void IBAMR::IBStrategySet::registerIBHierarchyIntegrator ( IBHierarchyIntegrator * ib_solver )

overridevirtual

Register the IBHierarchyIntegrator object that is using this strategy class.

Reimplemented from IBAMR::IBStrategy.

◆ registerEulerianVariables()

void IBAMR::IBStrategySet::registerEulerianVariables ( )

overridevirtual

Register Eulerian variables with the parent IBHierarchyIntegrator with the VariableDatabase, or via the various versions of the protected method IBStrategy::registerVariable().

Reimplemented from IBAMR::IBStrategy.

◆ registerEulerianCommunicationAlgorithms()

void IBAMR::IBStrategySet::registerEulerianCommunicationAlgorithms ( )

overridevirtual

Register Eulerian refinement or coarsening algorithms with the parent IBHierarchyIntegrator using the two versions of the protected methods IBStrategy::registerGhostfillRefineAlgorithm(), IBStrategy::registerProlongRefineAlgorithm(), and IBStrategy::registerCoarsenAlgorithm().

Reimplemented from IBAMR::IBStrategy.

◆ getMinimumGhostCellWidth()

const SAMRAI::hier::IntVector<NDIM>& IBAMR::IBStrategySet::getMinimumGhostCellWidth ( ) const

overridevirtual

Return the number of ghost cells required by the Lagrangian-Eulerian interaction routines.

Implements IBAMR::IBStrategy.

◆ setupTagBuffer()

void IBAMR::IBStrategySet::setupTagBuffer	(	SAMRAI::tbox::Array< int > &	tag_buffer,
		SAMRAI::tbox::Pointer< SAMRAI::mesh::GriddingAlgorithm< NDIM > >	gridding_alg
	)		const

overridevirtual

Setup the tag buffer.

Reimplemented from IBAMR::IBStrategy.

◆ getMaxPointDisplacement()

virtual double IBAMR::IBStrategySet::getMaxPointDisplacement ( ) const

overridevirtual

Same as the base class: considers all owned IBStrategy objects.

Reimplemented from IBAMR::IBStrategy.

◆ preprocessIntegrateData()

void IBAMR::IBStrategySet::preprocessIntegrateData	(	double	current_time,
		double	new_time,
		int	num_cycles
	)

overridevirtual

Method to prepare to advance data from current_time to new_time.

Reimplemented from IBAMR::IBStrategy.

◆ postprocessIntegrateData()

void IBAMR::IBStrategySet::postprocessIntegrateData	(	double	current_time,
		double	new_time,
		int	num_cycles
	)

overridevirtual

Method to clean up data following call(s) to integrateHierarchy().

Reimplemented from IBAMR::IBStrategy.

◆ updateFixedLEOperators()

void IBAMR::IBStrategySet::updateFixedLEOperators ( )

overridevirtual

Update the positions used for the "fixed" interpolation and spreading operators.

Reimplemented from IBAMR::IBStrategy.

◆ interpolateVelocity()

void IBAMR::IBStrategySet::interpolateVelocity	(	int	u_data_idx,
		const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenSchedule< NDIM > > > &	u_synch_scheds,
		const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &	u_ghost_fill_scheds,
		double	data_time
	)

overridevirtual

Interpolate the Eulerian velocity to the curvilinear mesh at the specified time within the current time interval.

Implements IBAMR::IBStrategy.

◆ forwardEulerStep()

void IBAMR::IBStrategySet::forwardEulerStep	(	double	current_time,
		double	new_time
	)

overridevirtual

Advance the positions of the Lagrangian structure using the forward Euler method.

Implements IBAMR::IBStrategy.

◆ midpointStep()

void IBAMR::IBStrategySet::midpointStep	(	double	current_time,
		double	new_time
	)

overridevirtual

Advance the positions of the Lagrangian structure using the (explicit) midpoint rule.

Implements IBAMR::IBStrategy.

◆ trapezoidalStep()

void IBAMR::IBStrategySet::trapezoidalStep	(	double	current_time,
		double	new_time
	)

overridevirtual

Advance the positions of the Lagrangian structure using the (explicit) trapezoidal rule.

Implements IBAMR::IBStrategy.

◆ computeLagrangianForce()

void IBAMR::IBStrategySet::computeLagrangianForce ( double data_time )

overridevirtual

Compute the Lagrangian force at the specified time within the current time interval.

Implements IBAMR::IBStrategy.

◆ spreadForce()

void IBAMR::IBStrategySet::spreadForce	(	int	f_data_idx,
		IBTK::RobinPhysBdryPatchStrategy *	f_phys_bdry_op,
		const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &	f_prolongation_scheds,
		double	data_time
	)

overridevirtual

Spread the Lagrangian force to the Cartesian grid at the specified time within the current time interval.

Implements IBAMR::IBStrategy.

◆ hasFluidSources()

bool IBAMR::IBStrategySet::hasFluidSources ( ) const

overridevirtual

Indicate whether there are any internal fluid sources/sinks.

Reimplemented from IBAMR::IBStrategy.

◆ computeLagrangianFluidSource()

void IBAMR::IBStrategySet::computeLagrangianFluidSource ( double data_time )

overridevirtual

Compute the Lagrangian source/sink density at the specified time within the current time interval.

Reimplemented from IBAMR::IBStrategy.

◆ spreadFluidSource()

void IBAMR::IBStrategySet::spreadFluidSource	(	int	q_data_idx,
		IBTK::RobinPhysBdryPatchStrategy *	q_phys_bdry_op,
		const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &	q_prolongation_scheds,
		double	data_time
	)

overridevirtual

Spread the Lagrangian source/sink density to the Cartesian grid at the specified time within the current time interval.

Reimplemented from IBAMR::IBStrategy.

◆ interpolatePressure()

void IBAMR::IBStrategySet::interpolatePressure	(	int	p_data_idx,
		const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenSchedule< NDIM > > > &	p_synch_scheds,
		const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &	p_ghost_fill_scheds,
		double	data_time
	)

overridevirtual

Compute the pressures at the positions of any distributed internal fluid sources or sinks.

Reimplemented from IBAMR::IBStrategy.

◆ preprocessSolveFluidEquations()

void IBAMR::IBStrategySet::preprocessSolveFluidEquations	(	double	current_time,
		double	new_time,
		int	cycle_num
	)

overridevirtual

Execute user-defined routines just before solving the fluid equations.

Reimplemented from IBAMR::IBStrategy.

◆ postprocessSolveFluidEquations()

void IBAMR::IBStrategySet::postprocessSolveFluidEquations	(	double	current_time,
		double	new_time,
		int	cycle_num
	)

overridevirtual

Execute user-defined routines just after solving the fluid equations.

Reimplemented from IBAMR::IBStrategy.

◆ postprocessData()

void IBAMR::IBStrategySet::postprocessData ( )

overridevirtual

Execute user-defined post-processing operations.

Reimplemented from IBAMR::IBStrategy.

◆ initializePatchHierarchy()

void IBAMR::IBStrategySet::initializePatchHierarchy	(	SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	hierarchy,
		SAMRAI::tbox::Pointer< SAMRAI::mesh::GriddingAlgorithm< NDIM > >	gridding_alg,
		int	u_data_idx,
		const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenSchedule< NDIM > > > &	u_synch_scheds,
		const std::vector< SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineSchedule< NDIM > > > &	u_ghost_fill_scheds,
		int	integrator_step,
		double	init_data_time,
		bool	initial_time
	)

overridevirtual

Initialize Lagrangian data corresponding to the given AMR patch hierarchy at the start of a computation. If the computation is begun from a restart file, data may be read from the restart databases.

A patch data descriptor is provided for the Eulerian velocity in case initialization requires interpolating Eulerian data. Ghost cells for Eulerian data will be filled upon entry to this function.

Reimplemented from IBAMR::IBStrategy.

◆ registerLoadBalancer()

void IBAMR::IBStrategySet::registerLoadBalancer	(	SAMRAI::tbox::Pointer< SAMRAI::mesh::LoadBalancer< NDIM > >	load_balancer,
		int	workload_data_idx
	)

overridevirtual

Register a load balancer and work load patch data index with the IB strategy object.

Deprecated:: This method is no longer necessary with the current workload estimation scheme.

Reimplemented from IBAMR::IBStrategy.

◆ addWorkloadEstimate()

void IBAMR::IBStrategySet::addWorkloadEstimate	(	SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	hierarchy,
		const int	workload_data_idx
	)

overridevirtual

Add the estimated computational work from the current object per cell into the specified workload_data_idx.

Reimplemented from IBAMR::IBStrategy.

◆ beginDataRedistribution()

void IBAMR::IBStrategySet::beginDataRedistribution	(	SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	hierarchy,
		SAMRAI::tbox::Pointer< SAMRAI::mesh::GriddingAlgorithm< NDIM > >	gridding_alg
	)

overridevirtual

Begin redistributing Lagrangian data prior to regridding the patch hierarchy.

Reimplemented from IBAMR::IBStrategy.

◆ endDataRedistribution()

void IBAMR::IBStrategySet::endDataRedistribution	(	SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	hierarchy,
		SAMRAI::tbox::Pointer< SAMRAI::mesh::GriddingAlgorithm< NDIM > >	gridding_alg
	)

overridevirtual

Complete redistributing Lagrangian data following regridding the patch hierarchy.

Reimplemented from IBAMR::IBStrategy.

◆ initializeLevelData() [1/2]

void IBAMR::IBStrategySet::initializeLevelData	(	SAMRAI::tbox::Pointer< SAMRAI::hier::BasePatchHierarchy< NDIM > >	hierarchy,
		int	level_number,
		double	init_data_time,
		bool	can_be_refined,
		bool	initial_time,
		SAMRAI::tbox::Pointer< SAMRAI::hier::BasePatchLevel< NDIM > >	old_level,
		bool	allocate_data
	)

override

Initialize data on a new level after it is inserted into an AMR patch hierarchy by the gridding algorithm.

See also: SAMRAI::mesh::StandardTagAndInitStrategy::initializeLevelData

◆ resetHierarchyConfiguration() [1/2]

void IBAMR::IBStrategySet::resetHierarchyConfiguration	(	SAMRAI::tbox::Pointer< SAMRAI::hier::BasePatchHierarchy< NDIM > >	hierarchy,
		int	coarsest_level,
		int	finest_level
	)

override

Reset cached hierarchy dependent data.

See also: SAMRAI::mesh::StandardTagAndInitStrategy::resetHierarchyConfiguration

◆ applyGradientDetector() [1/2]

void IBAMR::IBStrategySet::applyGradientDetector	(	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
	)

override

Set integer tags to "one" in cells where refinement of the given level should occur according to user-supplied feature detection criteria.

See also: SAMRAI::mesh::StandardTagAndInitStrategy::applyGradientDetector

◆ putToDatabase()

void IBAMR::IBStrategySet::putToDatabase ( SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db )

overridevirtual

Write out object state to the given database.

Reimplemented from IBAMR::IBStrategy.

◆ operator=()

IBStrategySet& IBAMR::IBStrategySet::operator= ( const IBStrategySet & that )

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.

◆ inactivateLagrangianStructure()

virtual void IBAMR::IBStrategy::inactivateLagrangianStructure	(	int	structure_number = `0`,
		int	level_number = `std::numeric_limits< int >::max()`
	)

virtualinherited

Inactivate a structure or part. Such a structure will be ignored by FSI calculations: i.e., it will have its velocity set to zero and no forces will be spread from the structure to the Eulerian grid.

Parameters

[in]	structure_number	Number of the structure/part.
[in]	level_number	Level on which the structure lives. For some inheriting classes (e.g., IBAMR::IBMethod) the structure number alone is not enough to establish uniqueness. The default value is interpreted as the finest level in the patch hierarchy.

Note: This method should be implemented by inheriting classes for which the notion of activating and inactivating a structure 'owned' by this class makes sense (for example, IBAMR::IBStrategySet does not directly own any structures, but IBAMR::IBMethod and IBAMR::IBFEMethod both do). The default implementation unconditionally aborts the program.

Reimplemented in IBAMR::IBFEMethod, and IBAMR::IBMethod.

◆ activateLagrangianStructure()

virtual void IBAMR::IBStrategy::activateLagrangianStructure	(	int	structure_number = `0`,
		int	level_number = `std::numeric_limits< int >::max()`
	)

virtualinherited

Activate a previously inactivated structure or part to be used again in FSI calculations.

Parameters

[in]	structure_number	Number of the structure/part.
[in]	level_number	Level on which the structure lives. For some inheriting classes (e.g., IBAMR::IBMethod) the structure number alone is not enough to establish uniqueness. The default value is interpreted as the finest level in the patch hierarchy.

Note: This method should be implemented by inheriting classes for which the notion of activating and inactivating a structure 'owned' by this class makes sense (for example, IBAMR::IBStrategySet does not directly own any structures, but IBAMR::IBMethod and IBAMR::IBFEMethod both do). The default implementation unconditionally aborts the program.

Reimplemented in IBAMR::IBFEMethod, and IBAMR::IBMethod.

◆ getLagrangianStructureIsActivated()

virtual bool IBAMR::IBStrategy::getLagrangianStructureIsActivated	(	int	structure_number = `0`,
		int	level_number = `std::numeric_limits< int >::max()`
	)		const

virtualinherited

Determine whether or not the given structure or part is currently activated.

Parameters

[in]	structure_number	Number of the structure/part.
[in]	level_number	Level on which the structure lives. For some inheriting classes (e.g., IBAMR::IBMethod) the structure number alone is not enough to establish uniqueness. The default value is interpreted as the finest level in the patch hierarchy.

Note: This method should be implemented by inheriting classes for which the notion of activating and inactivating a structure 'owned' by this class makes sense (for example, IBAMR::IBStrategySet does not directly own any structures, but IBAMR::IBMethod and IBAMR::IBFEMethod both do). The default implementation unconditionally aborts the program.

Reimplemented in IBAMR::IBFEMethod, and IBAMR::IBMethod.

◆ setUseFixedLEOperators()

void IBAMR::IBStrategy::setUseFixedLEOperators ( bool use_fixed_coupling_ops = true )

inherited

Indicate whether "fixed" interpolation and spreading operators should be used during Lagrangian-Eulerian interaction.

◆ setUseMultistepTimeStepping()

virtual void IBAMR::IBStrategy::setUseMultistepTimeStepping ( unsigned int n_previous_steps = 1 )

virtualinherited

Indicate that multistep time stepping will be used.

A default implementation is provided that emits an unrecoverable exception.

Parameters

[in] n_previous_steps Number of previous solution values that can be used by the multistep scheme.

Reimplemented in IBAMR::IBFEMethod.

◆ backwardEulerStep()

virtual void IBAMR::IBStrategy::backwardEulerStep	(	double	current_time,
		double	new_time
	)

virtualinherited

Advance the positions of the Lagrangian structure using the (explicit) backward Euler method.

A default implementation is provided that emits an unrecoverable exception.

Reimplemented in IBAMR::IBFEMethod, IBAMR::CIBMethod, IBAMR::IBMethod, and IBAMR::IBInterpolantMethod.

◆ AB2Step()

virtual void IBAMR::IBStrategy::AB2Step	(	double	current_time,
		double	new_time
	)

virtualinherited

Advance the positions of the Lagrangian structure using the standard 2nd-order Adams-Bashforth rule.

A default implementation is provided that emits an unrecoverable exception.

Reimplemented in IBAMR::IBFEMethod.

◆ initializeLevelData() [2/2]

virtual void SAMRAI::mesh::StandardTagAndInitStrategy< DIM >::initializeLevelData	(	const tbox::Pointer< hier::BasePatchHierarchy< DIM > >	hierarchy,
		const int	level_number,
		const double	init_data_time,
		const bool	can_be_refined,
		const bool	initial_time,
		const tbox::Pointer< hier::BasePatchLevel< DIM > >	old_level = `tbox::Pointer< hier::BasePatchLevel<DIM> >(NULL)`,
		const bool	allocate_data = `true`
	)

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() [2/2]

virtual void SAMRAI::mesh::StandardTagAndInitStrategy< DIM >::resetHierarchyConfiguration	(	const tbox::Pointer< hier::BasePatchHierarchy< DIM > >	hierarchy,
		const int	coarsest_level,
		const int	finest_level
	)

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() [2/2]

virtual void SAMRAI::mesh::StandardTagAndInitStrategy< DIM >::applyGradientDetector	(	const tbox::Pointer< hier::BasePatchHierarchy< DIM > >	hierarchy,
		const int	level_number,
		const double	error_data_time,
		const int	tag_index,
		const bool	initial_time,
		const bool	uses_richardson_extrapolation_too
	)

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.

◆ getINSHierarchyIntegrator()

INSHierarchyIntegrator* IBAMR::IBStrategy::getINSHierarchyIntegrator ( ) const

protectedinherited

Return a pointer to the INSHierarchyIntegrator object being used with the IBHierarchyIntegrator class registered with this IBStrategy object.

◆ getVelocityHierarchyDataOps()

SAMRAI::tbox::Pointer<SAMRAI::math::HierarchyDataOpsReal<NDIM, double> > IBAMR::IBStrategy::getVelocityHierarchyDataOps ( ) const

protectedinherited

Return a pointer to the HierarchyDataOpsReal object associated with velocity-like variables.

◆ getPressureHierarchyDataOps()

SAMRAI::tbox::Pointer<SAMRAI::math::HierarchyDataOpsReal<NDIM, double> > IBAMR::IBStrategy::getPressureHierarchyDataOps ( ) const

protectedinherited

Return a pointer to the HierarchyDataOpsReal object associated with pressure-like variables.

◆ getHierarchyMathOps()

SAMRAI::tbox::Pointer<IBTK::HierarchyMathOps> IBAMR::IBStrategy::getHierarchyMathOps ( ) const

protectedinherited

Return a pointer to a HierarchyMathOps object.

◆ registerVariable() [1/2]

void IBAMR::IBStrategy::registerVariable	(	int &	current_idx,
		int &	new_idx,
		int &	scratch_idx,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > >	variable,
		const SAMRAI::hier::IntVector< NDIM > &	scratch_ghosts = `SAMRAI::hier::IntVector< NDIM >(0)`,
		const std::string &	coarsen_name = `"NO_COARSEN"`,
		const std::string &	refine_name = `"NO_REFINE"`,
		SAMRAI::tbox::Pointer< IBTK::CartGridFunction >	init_fcn = `nullptr`,
		const bool	register_for_restart = `true`
	)

protectedinherited

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]

void IBAMR::IBStrategy::registerVariable	(	int &	idx,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > >	variable,
		const SAMRAI::hier::IntVector< NDIM > &	ghosts = `SAMRAI::hier::IntVector< NDIM >(0)`,
		SAMRAI::tbox::Pointer< SAMRAI::hier::VariableContext >	ctx = `SAMRAI::tbox::Pointer< SAMRAI::hier::VariableContext >(nullptr)`,
		const bool	register_for_restart = `true`
	)

protectedinherited

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.

◆ registerGhostfillRefineAlgorithm()

void IBAMR::IBStrategy::registerGhostfillRefineAlgorithm	(	const std::string &	name,
		SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineAlgorithm< NDIM > >	ghostfill_alg,
		std::unique_ptr< SAMRAI::xfer::RefinePatchStrategy< NDIM > >	ghostfill_patch_strategy = `nullptr`
	)

protectedinherited

Register a ghost cell-filling refine algorithm.

◆ registerProlongRefineAlgorithm()

void IBAMR::IBStrategy::registerProlongRefineAlgorithm	(	const std::string &	name,
		SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineAlgorithm< NDIM > >	prolong_alg,
		std::unique_ptr< SAMRAI::xfer::RefinePatchStrategy< NDIM > >	prolong_patch_strategy = `nullptr`
	)

protectedinherited

Register a data-prolonging refine algorithm.

◆ registerCoarsenAlgorithm()

void IBAMR::IBStrategy::registerCoarsenAlgorithm	(	const std::string &	name,
		SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenAlgorithm< NDIM > >	coarsen_alg,
		std::unique_ptr< SAMRAI::xfer::CoarsenPatchStrategy< NDIM > >	coarsen_patch_strategy = `nullptr`
	)

protectedinherited

Register a coarsen algorithm.

◆ getGhostfillRefineAlgorithm()

SAMRAI::tbox::Pointer<SAMRAI::xfer::RefineAlgorithm<NDIM> > IBAMR::IBStrategy::getGhostfillRefineAlgorithm ( const std::string & name ) const

protectedinherited

Get ghost cell-filling refine algorithm.

◆ getProlongRefineAlgorithm()

SAMRAI::tbox::Pointer<SAMRAI::xfer::RefineAlgorithm<NDIM> > IBAMR::IBStrategy::getProlongRefineAlgorithm ( const std::string & name ) const

protectedinherited

Get data-prolonging refine algorithm.

◆ getCoarsenAlgorithm()

SAMRAI::tbox::Pointer<SAMRAI::xfer::CoarsenAlgorithm<NDIM> > IBAMR::IBStrategy::getCoarsenAlgorithm ( const std::string & name ) const

protectedinherited

Get coarsen algorithm.

◆ getGhostfillRefineSchedules()

const std::vector<SAMRAI::tbox::Pointer<SAMRAI::xfer::RefineSchedule<NDIM> > >& IBAMR::IBStrategy::getGhostfillRefineSchedules ( const std::string & name ) const

protectedinherited

Get ghost cell-filling refine schedules.

◆ getProlongRefineSchedules()

const std::vector<SAMRAI::tbox::Pointer<SAMRAI::xfer::RefineSchedule<NDIM> > >& IBAMR::IBStrategy::getProlongRefineSchedules ( const std::string & name ) const

protectedinherited

Get data-prolonging refine schedules.

Note: These schedules are allocated only for level numbers >= 1.

◆ getCoarsenSchedules()

const std::vector<SAMRAI::tbox::Pointer<SAMRAI::xfer::CoarsenSchedule<NDIM> > >& IBAMR::IBStrategy::getCoarsenSchedules ( const std::string & name ) const

protectedinherited

Get coarsen schedules.

Note: These schedules are allocated only for level numbers >= 1.

◆ getLevelDt()

virtual double SAMRAI::mesh::StandardTagAndInitStrategy< DIM >::getLevelDt	(	const tbox::Pointer< hier::BasePatchLevel< DIM > >	level,
		const double	dt_time,
		const bool	initial_time
	)

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()

virtual double SAMRAI::mesh::StandardTagAndInitStrategy< DIM >::advanceLevel	(	const tbox::Pointer< hier::BasePatchLevel< DIM > >	level,
		const tbox::Pointer< hier::BasePatchHierarchy< DIM > >	hierarchy,
		const double	current_time,
		const double	new_time,
		const bool	first_step,
		const bool	last_step,
		const bool	regrid_advance = `false`
	)

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()

virtual void SAMRAI::mesh::StandardTagAndInitStrategy< DIM >::resetTimeDependentData	(	const tbox::Pointer< hier::BasePatchLevel< DIM > >	level,
		const double	new_time,
		const bool	can_be_refined
	)

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()

virtual void SAMRAI::mesh::StandardTagAndInitStrategy< DIM >::resetDataToPreadvanceState ( const tbox::Pointer< hier::BasePatchLevel< DIM > > level )

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()

virtual void SAMRAI::mesh::StandardTagAndInitStrategy< DIM >::applyRichardsonExtrapolation	(	const tbox::Pointer< hier::PatchLevel< DIM > >	level,
		const double	error_data_time,
		const int	tag_index,
		const double	deltat,
		const int	error_coarsen_ratio,
		const bool	initial_time,
		const bool	uses_gradient_detector_too
	)

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()

virtual void SAMRAI::mesh::StandardTagAndInitStrategy< DIM >::coarsenDataForRichardsonExtrapolation	(	const tbox::Pointer< hier::PatchHierarchy< DIM > >	hierarchy,
		const int	level_number,
		const tbox::Pointer< hier::PatchLevel< DIM > >	coarser_level,
		const double	coarsen_data_time,
		const bool	before_advance
	)

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_strategy_set

std::vector<SAMRAI::tbox::Pointer<IBStrategy> > IBAMR::IBStrategySet::d_strategy_set

private

◆ d_ib_solver

IBHierarchyIntegrator* IBAMR::IBStrategy::d_ib_solver = nullptr

protectedinherited

The IBHierarchyIntegrator object that is using this strategy class.

◆ d_use_fixed_coupling_ops

bool IBAMR::IBStrategy::d_use_fixed_coupling_ops = false

protectedinherited

Whether to use "fixed" Lagrangian-Eulerian coupling operators.

The documentation for this class was generated from the following file:

include/ibamr/IBStrategySet.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ IBStrategySet() [1/2]

◆ IBStrategySet() [2/2]

Member Function Documentation

◆ registerIBHierarchyIntegrator()

◆ registerEulerianVariables()

◆ registerEulerianCommunicationAlgorithms()

◆ getMinimumGhostCellWidth()

◆ setupTagBuffer()

◆ getMaxPointDisplacement()

◆ preprocessIntegrateData()

◆ postprocessIntegrateData()

◆ updateFixedLEOperators()

◆ interpolateVelocity()

◆ forwardEulerStep()

◆ midpointStep()

◆ trapezoidalStep()

◆ computeLagrangianForce()

◆ spreadForce()

◆ hasFluidSources()

◆ computeLagrangianFluidSource()

◆ spreadFluidSource()

◆ interpolatePressure()

◆ preprocessSolveFluidEquations()

◆ postprocessSolveFluidEquations()

◆ postprocessData()

◆ initializePatchHierarchy()

◆ registerLoadBalancer()

◆ addWorkloadEstimate()

◆ beginDataRedistribution()

◆ endDataRedistribution()

◆ initializeLevelData() [1/2]

◆ resetHierarchyConfiguration() [1/2]

◆ applyGradientDetector() [1/2]

◆ putToDatabase()

◆ operator=()

◆ inactivateLagrangianStructure()

◆ activateLagrangianStructure()

◆ getLagrangianStructureIsActivated()

◆ setUseFixedLEOperators()

◆ setUseMultistepTimeStepping()

◆ backwardEulerStep()

◆ AB2Step()

◆ initializeLevelData() [2/2]

◆ resetHierarchyConfiguration() [2/2]

◆ applyGradientDetector() [2/2]

◆ getINSHierarchyIntegrator()

◆ getVelocityHierarchyDataOps()

◆ getPressureHierarchyDataOps()

◆ getHierarchyMathOps()

◆ registerVariable() [1/2]

◆ registerVariable() [2/2]

◆ registerGhostfillRefineAlgorithm()

◆ registerProlongRefineAlgorithm()

◆ registerCoarsenAlgorithm()

◆ getGhostfillRefineAlgorithm()

◆ getProlongRefineAlgorithm()

◆ getCoarsenAlgorithm()

◆ getGhostfillRefineSchedules()

◆ getProlongRefineSchedules()

◆ getCoarsenSchedules()

◆ getLevelDt()

◆ advanceLevel()

◆ resetTimeDependentData()

◆ resetDataToPreadvanceState()

◆ applyRichardsonExtrapolation()

◆ coarsenDataForRichardsonExtrapolation()

Member Data Documentation

◆ d_strategy_set

◆ d_ib_solver

◆ d_use_fixed_coupling_ops