IBAMR
An adaptive and distributed-memory parallel implementation of the immersed boundary (IB) method
|
Class VCStaggeredStokesOperator is a concrete IBTK::LinearOperator which implements a staggered-grid (MAC) discretization of the incompressible Stokes operator with variable coefficients. More...
#include </home/runner/work/IBAMR/IBAMR/include/ibamr/VCStaggeredStokesOperator.h>
Public Member Functions | |
VCStaggeredStokesOperator (const std::string &object_name, bool homogeneous_bc=true, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db=nullptr) | |
Class constructor. | |
~VCStaggeredStokesOperator () | |
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 | 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. | |
Linear operator functionality. | |
void | apply (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &y) override |
Compute y=Ax. More... | |
void | setDPatchDataInterpolationType (IBTK::VCInterpType D_interp_type) |
Set the interpolation type to be used in computing the variable coefficient viscous Laplacian. | |
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 VCStaggeredStokesOperator is a concrete IBTK::LinearOperator which implements a staggered-grid (MAC) discretization of the incompressible Stokes operator with variable coefficients.
This class is intended to be used with an iterative (Krylov or Newton-Krylov) incompressible flow solver.
|
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:
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.
x | input |
y | output: y=Ax |
Implements IBTK::GeneralOperator.