IBAMR
An adaptive and distributed-memory parallel implementation of the immersed boundary (IB) method
|
Class PETScMFFDJacobianOperator provides a method for computing Jacobian-vector products, i.e., , via a matrix-free finite-difference approach. More...
#include </home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/PETScMFFDJacobianOperator.h>
Public Member Functions | |
PETScMFFDJacobianOperator (std::string object_name, std::string options_prefix="") | |
Constructor. | |
~PETScMFFDJacobianOperator () | |
Empty destructor. | |
void | setOperator (SAMRAI::tbox::Pointer< GeneralOperator > F) |
Set the operator to use in computing approximations to Jacobian-vector products. | |
void | setNewtonKrylovSolver (SAMRAI::tbox::Pointer< PETScNewtonKrylovSolver > nonlinear_solver) |
Set the PETScNewtonKrylov solver using this object to compute Jacobian-vector products. | |
General Jacobian functionality. | |
void | formJacobian (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u) override |
Compute hierarchy dependent data required for evaluating F'[x]. More... | |
SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > > | getBaseVector () const override |
Return the vector where the Jacobian is evaluated. More... | |
Public Member Functions inherited from IBTK::JacobianOperator | |
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 | 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 z=Ax+y. More... | |
void | deallocateOperatorState () override |
Remove all hierarchy dependent data allocated by initializeOperatorState(). 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 |
Class PETScMFFDJacobianOperator provides a method for computing Jacobian-vector products, i.e., , via a matrix-free finite-difference approach.
|
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. The user is responsible for managing the storage for the vectors.
Conditions on arguments:
In general, the vectors x and y cannot be the same.
x | input |
y | output: y=Ax |
Implements IBTK::GeneralOperator.
|
overridevirtual |
Remove all hierarchy dependent data allocated by initializeOperatorState().
Remove all hierarchy dependent data set by initializeOperatorState(). It is safe to call deallocateOperatorState() when the operator state is already deallocated.
Reimplemented from IBTK::GeneralOperator.
|
overridevirtual |
Compute hierarchy dependent data required for evaluating F'[x].
x | value where the Jacobian is to be evaluated |
Implements IBTK::JacobianOperator.
|
overridevirtual |
Return the vector where the Jacobian is evaluated.
Implements IBTK::JacobianOperator.
|
overridevirtual |
Compute hierarchy dependent data required for computing y=Ax and z=Ax+y.
The vector arguments for apply(), applyAdd(), etc, need not match those for initializeOperatorState(). However, there must be a certain degree of similarity, including
It is safe to call initializeOperatorState() when the state is already initialized. In this case, the operator state is first deallocated and then reinitialized.
Conditions on arguments:
Call deallocateOperatorState() to remove any data allocated by this method.
in | input vector |
out | output vector |
Reimplemented from IBTK::GeneralOperator.