Class JacobianOperator provides an abstract interface for the specification of general operators to compute Jacobian-vector products, i.e., $ F'[x]v $ . More...

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

Inheritance diagram for IBTK::JacobianOperator:

[legend]

Public Member Functions
	JacobianOperator (std::string object_name)
	Constructor.

	~JacobianOperator ()=default
	Empty destructor.

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

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

virtual void	deallocateOperatorState ()
	Remove all hierarchy dependent data allocated by initializeOperatorState(). 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.

General Jacobian functionality.
virtual void	formJacobian (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x)=0
	Compute hierarchy dependent data required for evaluating F'[x]. More...

virtual SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > >	getBaseVector () const =0
	Return the vector where the Jacobian is evaluated. More...

Additional Inherited Members
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 JacobianOperator provides an abstract interface for the specification of general operators to compute Jacobian-vector products, i.e., $ F'[x]v $ .

Member Function Documentation

◆ formJacobian()

virtual void IBTK::JacobianOperator::formJacobian ( SAMRAI::solv::SAMRAIVectorReal< NDIM, double > & x )

pure virtual

Compute hierarchy dependent data required for evaluating F'[x].

Parameters

x	value where the Jacobian is to be evaluated

Implemented in IBTK::PETScSNESJacobianJOWrapper, and IBTK::PETScMFFDJacobianOperator.

◆ getBaseVector()

virtual SAMRAI::tbox::Pointer<SAMRAI::solv::SAMRAIVectorReal<NDIM, double> > IBTK::JacobianOperator::getBaseVector ( ) const

pure virtual

Return the vector where the Jacobian is evaluated.

Note: Implementations of this member function are permitted to return a nullptr pointer if the operator is not initialized, or if formJacobian() has not been called.

Implemented in IBTK::PETScSNESJacobianJOWrapper, and IBTK::PETScMFFDJacobianOperator.

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

/home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/JacobianOperator.h
/home/runner/work/IBAMR/IBAMR/ibtk/src/solvers/interfaces/JacobianOperator.cpp

Public Member Functions

General Jacobian functionality.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ formJacobian()

◆ getBaseVector()