Class LaplaceOperator is an abstract base class for a Laplace-type operators. More...

#include </home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/LaplaceOperator.h>

Inheritance diagram for IBTK::LaplaceOperator:

[legend]

Public Member Functions
	LaplaceOperator (std::string object_name, bool homogeneous_bc=false)
	Constructor.

	~LaplaceOperator ()=default
	Default destructor.

virtual void	setPoissonSpecifications (const SAMRAI::solv::PoissonSpecifications &poisson_spec)
	Set the SAMRAI::solv::PoissonSpecifications object used to specify the coefficients for the scalar-valued or vector-valued Laplace operator.

virtual const SAMRAI::solv::PoissonSpecifications &	getPoissonSpecifications () const
	Get the SAMRAI::solv::PoissonSpecifications object used to specify the coefficients for the scalar-valued or vector-valued Laplace operator.

virtual void	setPhysicalBcCoef (SAMRAI::solv::RobinBcCoefStrategy< NDIM > *bc_coef)
	Set the SAMRAI::solv::RobinBcCoefStrategy object used to specify physical boundary conditions.

virtual void	setPhysicalBcCoefs (const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &bc_coefs)
	Set the SAMRAI::solv::RobinBcCoefStrategy objects used to specify physical boundary conditions.

virtual const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	getPhysicalBcCoefs () const
	Get the SAMRAI::solv::RobinBcCoefStrategy object(s) used to specify physical boundary conditions.

Public Member Functions inherited from IBTK::LinearOperator
	LinearOperator (std::string object_name, bool homogeneous_bc=false)
	Constructor.

	~LinearOperator ()
	Empty destructor.

void	modifyRhsForBcs (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &y) override
	Modify y to account for boundary conditions.

Public Member Functions inherited from IBTK::GeneralOperator
	GeneralOperator (std::string object_name, bool homogeneous_bc=false)
	Constructor.

virtual	~GeneralOperator ()
	Empty virtual destructor.

const std::string &	getName () const
	Return the object name.

virtual bool	getIsInitialized () const
	Return whether the operator is initialized.

virtual void	setHomogeneousBc (bool homogeneous_bc)
	Set whether the operator should use homogeneous boundary conditions.

virtual bool	getHomogeneousBc () const
	Return whether the operator is using homogeneous boundary conditions.

virtual void	setSolutionTime (double solution_time)
	Set the time at which the solution is to be evaluated.

virtual double	getSolutionTime () const
	Get the time at which the solution is being evaluated.

virtual void	setTimeInterval (double current_time, double new_time)
	Set the current time interval.

virtual std::pair< double, double >	getTimeInterval () const
	Get the current time interval.

virtual double	getDt () const
	Get the current time step size.

virtual void	setHierarchyMathOps (SAMRAI::tbox::Pointer< HierarchyMathOps > hier_math_ops)
	Set the HierarchyMathOps object used by the operator.

virtual SAMRAI::tbox::Pointer< HierarchyMathOps >	getHierarchyMathOps () const
	Get the HierarchyMathOps object used by the operator.

virtual void	apply (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &y)=0
	Compute .

virtual void	applyAdd (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &y, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &z)
	Compute .

virtual void	initializeOperatorState (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &in, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &out)
	Compute hierarchy dependent data required for computing y=F[x] and z=F[x]+y.

virtual void	deallocateOperatorState ()
	Remove all hierarchy dependent data allocated by initializeOperatorState().

virtual void	imposeSolBcs (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u)
	Impose boudary conditions in the solution vector.

virtual void	setLoggingEnabled (bool enable_logging=true)
	Enable or disable logging.

virtual bool	getLoggingEnabled () const
	Determine whether logging is enabled or disabled.

virtual void	printClassData (std::ostream &stream)
	Print class data to stream.

Protected Attributes
SAMRAI::solv::PoissonSpecifications	d_poisson_spec

std::unique_ptr< SAMRAI::solv::RobinBcCoefStrategy< NDIM > >	d_default_bc_coef

std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * >	d_bc_coefs

Protected Attributes inherited from IBTK::GeneralOperator
const std::string	d_object_name

bool	d_is_initialized = false

bool	d_homogeneous_bc

double	d_solution_time = std::numeric_limits<double>::quiet_NaN()

double	d_current_time = std::numeric_limits<double>::quiet_NaN()

double	d_new_time = std::numeric_limits<double>::quiet_NaN()

SAMRAI::tbox::Pointer< HierarchyMathOps >	d_hier_math_ops

bool	d_hier_math_ops_external = false

bool	d_enable_logging = false

Detailed Description

Class LaplaceOperator is an abstract base class for a Laplace-type operators.

Member Function Documentation

◆ setPhysicalBcCoef()

void IBTK::LaplaceOperator::setPhysicalBcCoef ( SAMRAI::solv::RobinBcCoefStrategy< NDIM > * bc_coef )

virtual

Set the SAMRAI::solv::RobinBcCoefStrategy object used to specify physical boundary conditions.

Note: bc_coef may be nullptr. In this case, default boundary conditions (as supplied to the class constructor) are employed.

Parameters

bc_coef Pointer to an object that can set the Robin boundary condition coefficients

◆ setPhysicalBcCoefs()

void IBTK::LaplaceOperator::setPhysicalBcCoefs ( const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > & bc_coefs )

virtual

Set the SAMRAI::solv::RobinBcCoefStrategy objects used to specify physical boundary conditions.

Note: Any of the elements of bc_coefs may be nullptr. In this case, default boundary conditions (as supplied to the class constructor) are employed for that data depth.

Parameters

bc_coefs Vector of pointers to objects that can set the Robin boundary condition coefficients

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

/home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/LaplaceOperator.h
/home/runner/work/IBAMR/IBAMR/ibtk/src/solvers/impls/LaplaceOperator.cpp

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ setPhysicalBcCoef()

◆ setPhysicalBcCoefs()