Class CCLaplaceOperator is a concrete LaplaceOperator which implements a globally second-order accurate cell-centered finite difference discretization of a scalar elliptic operator of the form $L = C I + \nabla \cdot D \nabla$ . More...

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

Inheritance diagram for IBTK::CCLaplaceOperator:

[legend]

Public Member Functions
	CCLaplaceOperator (std::string object_name, bool homogeneous_bc=true)
	Constructor for class CCLaplaceOperator initializes the operator coefficients and boundary conditions to default values.

	~CCLaplaceOperator ()
	Destructor.

Public Member Functions inherited from IBTK::LaplaceOperator
	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. More...

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

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. More...

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	applyAdd (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &y, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &z)
	Compute . More...

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

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.

Linear operator functionality.
void	apply (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &y) override
	Compute y=Ax. More...

void	initializeOperatorState (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &in, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &out) override
	Compute hierarchy-dependent data required for computing y=Ax (and y=A'x). More...

void	deallocateOperatorState () override
	Remove all hierarchy-dependent data computed by initializeOperatorState(). More...

Additional Inherited Members
Protected Attributes inherited from IBTK::LaplaceOperator
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 CCLaplaceOperator is a concrete LaplaceOperator which implements a globally second-order accurate cell-centered finite difference discretization of a scalar elliptic operator of the form $L = C I + \nabla \cdot D \nabla$ .

Member Function Documentation

◆ apply()

void IBTK::CCLaplaceOperator::apply	(	SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	x,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	y
	)

overridevirtual

Compute y=Ax.

Before calling this function, the form of the vectors x and y should be set properly by the user on all patch interiors on the range of levels covered by the operator. All data in these vectors should be allocated. Thus, the user is responsible for managing the storage for the vectors.

Conditions on arguments:

vectors must have same hierarchy
vectors must have same variables (except that x must have enough ghost cells for computation of Ax).

Note: In general, the vectors x and y cannot be the same.

Upon return from this function, the y vector will contain the result of the application of A to x.

initializeOperatorState must be called prior to any calls to applyOperator.

See also: initializeOperatorState

Parameters

x	input
y	output: y=Ax

Implements IBTK::GeneralOperator.

◆ deallocateOperatorState()

void IBTK::CCLaplaceOperator::deallocateOperatorState ( )

overridevirtual

Remove all hierarchy-dependent data computed by initializeOperatorState().

Remove all hierarchy-dependent data set by initializeOperatorState(). It is safe to call deallocateOperatorState() even if the state is already deallocated.

See also: initializeOperatorState; KrylovLinearSolver::deallocateSolverState

Reimplemented from IBTK::GeneralOperator.

◆ initializeOperatorState()

void IBTK::CCLaplaceOperator::initializeOperatorState	(	const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	in,
		const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	out
	)

overridevirtual

Compute hierarchy-dependent data required for computing y=Ax (and y=A'x).

Parameters

in	input vector
out	output vector

See also: KrylovLinearSolver::initializeSolverState

Reimplemented from IBTK::GeneralOperator.

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

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

Public Member Functions

Linear operator functionality.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply()

◆ deallocateOperatorState()

◆ initializeOperatorState()