IBAMR::ConvectiveOperator Class Reference

Class ConvectiveOperator is a abstract class for an implementation of a convective differencing operator.

#include <ibamr/ConvectiveOperator.h>

Inheritance diagram for IBAMR::ConvectiveOperator:

Public Member Functions
	ConvectiveOperator (std::string object_name, ConvectiveDifferencingType difference_form)
	Class constructor. More...
	~ConvectiveOperator ()
	Destructor. More...
void	setAdvectionVelocity (int u_idx)
	Set the patch data index corresponding to the advection velocity to be used when computing the convective derivative. More...
int	getAdvectionVelocity () const
	Get the patch data index corresponding to the advection velocity used when computing the convective derivative. More...
void	setConvectiveDifferencingType (ConvectiveDifferencingType difference_form)
	Set the convective differencing form to be used by the operator. More...
ConvectiveDifferencingType	getConvectiveDifferencingType () const
	Get the convective differencing form used by the operator. More...
virtual void	applyConvectiveOperator (int Q_idx, int N_idx)=0
	Compute N = u * grad Q. More...

General operator functionality.
ConvectiveDifferencingType	d_difference_form
int	d_u_idx = IBTK::invalid_index
void	apply (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &y) override
	Compute \(y=F[x]\). More...
	ConvectiveOperator ()=delete
	Default constructor. More...
	ConvectiveOperator (const ConvectiveOperator &from)=delete
	Copy constructor. More...
ConvectiveOperator &	operator= (const ConvectiveOperator &that)=delete
	Assignment operator. More...

General operator functionality.
const std::string &	getName () const
	Return the object name. More...
virtual bool	getIsInitialized () const
	Return whether the operator is initialized. More...
virtual void	setHomogeneousBc (bool homogeneous_bc)
	Set whether the operator should use homogeneous boundary conditions. More...
virtual bool	getHomogeneousBc () const
	Return whether the operator is using homogeneous boundary conditions. More...
virtual void	setSolutionTime (double solution_time)
	Set the time at which the solution is to be evaluated. More...
virtual double	getSolutionTime () const
	Get the time at which the solution is being evaluated. More...
virtual void	setTimeInterval (double current_time, double new_time)
	Set the current time interval. More...
virtual std::pair< double, double >	getTimeInterval () const
	Get the current time interval. More...
virtual double	getDt () const
	Get the current time step size. More...
virtual void	setHierarchyMathOps (SAMRAI::tbox::Pointer< HierarchyMathOps > hier_math_ops)
	Set the HierarchyMathOps object used by the operator. More...
virtual SAMRAI::tbox::Pointer< HierarchyMathOps >	getHierarchyMathOps () const
	Get the HierarchyMathOps object used by the operator. More...
virtual void	applyAdd (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &y, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &z)
	Compute \(z=F[x]+y\). 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	modifyRhsForBcs (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &y)
	Modify the RHS vector to account for boundary conditions. More...
virtual void	imposeSolBcs (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u)
	Impose boudary conditions in the solution vector. More...

Logging functions.
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
virtual void	setLoggingEnabled (bool enable_logging=true)
	Enable or disable logging. More...
virtual bool	getLoggingEnabled () const
	Determine whether logging is enabled or disabled. More...
virtual void	printClassData (std::ostream &stream)
	Print class data to stream. More...

Constructor & Destructor Documentation

ConvectiveOperator() [1/3]

IBAMR::ConvectiveOperator::ConvectiveOperator	(	std::string	object_name,
		ConvectiveDifferencingType	difference_form
	)

~ConvectiveOperator()

IBAMR::ConvectiveOperator::~ConvectiveOperator

(

)

ConvectiveOperator() [2/3]

IBAMR::ConvectiveOperator::ConvectiveOperator ( )

privatedelete

Note

This constructor is not implemented and should not be used.

ConvectiveOperator() [3/3]

IBAMR::ConvectiveOperator::ConvectiveOperator ( const ConvectiveOperator &  from )

privatedelete

Note

This constructor is not implemented and should not be used.

Parameters

from	The value to copy to this object.

Member Function Documentation

setAdvectionVelocity()

void IBAMR::ConvectiveOperator::setAdvectionVelocity

(

int

u_idx

)

getAdvectionVelocity()

int IBAMR::ConvectiveOperator::getAdvectionVelocity

(

)

const

setConvectiveDifferencingType()

void IBAMR::ConvectiveOperator::setConvectiveDifferencingType

(

ConvectiveDifferencingType

difference_form

)

getConvectiveDifferencingType()

ConvectiveDifferencingType IBAMR::ConvectiveOperator::getConvectiveDifferencingType

(

)

const

applyConvectiveOperator()

virtual void IBAMR::ConvectiveOperator::applyConvectiveOperator ( int  Q_idx, int  N_idx  )

pure virtual

Implemented in IBAMR::INSCollocatedPPMConvectiveOperator, IBAMR::INSStaggeredCUIConvectiveOperator, IBAMR::INSCollocatedCenteredConvectiveOperator, IBAMR::INSStaggeredWavePropConvectiveOperator, IBAMR::INSStaggeredStabilizedPPMConvectiveOperator, IBAMR::INSCollocatedWavePropConvectiveOperator, IBAMR::INSStaggeredPPMConvectiveOperator, IBAMR::INSStaggeredCenteredConvectiveOperator, IBAMR::INSStaggeredUpwindConvectiveOperator, IBAMR::AdvDiffWavePropConvectiveOperator, IBAMR::CFUpperConvectiveOperator, and IBAMR::CellConvectiveOperator.

apply()

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

overridevirtual

Before calling apply(), the form of the vectors x and y should be set properly by the user on all patch interiors on the specified range of levels in the patch hierarchy. The user is responsible for all data management for the quantities associated with the vectors. In particular, patch data in these vectors must be allocated prior to calling this method.

Parameters

x	input vector
y	output vector, i.e., \(y=F[x]\)

Conditions on Parameters:

• vectors x and y must have same hierarchy
• vectors x and y must have same structure, depth, etc.

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

See also

initializeOperatorState

Implements IBTK::GeneralOperator.

operator=()

ConvectiveOperator& IBAMR::ConvectiveOperator::operator= ( const ConvectiveOperator &  that )

privatedelete

Note

This operator is not implemented and should not be used.

Parameters

that	The value to assign to this object.

Returns

A reference to this object.

getName()

const std::string& IBTK::GeneralOperator::getName ( ) const

inherited

getIsInitialized()

virtual bool IBTK::GeneralOperator::getIsInitialized ( ) const

virtualinherited

setHomogeneousBc()

virtual void IBTK::GeneralOperator::setHomogeneousBc ( bool  homogeneous_bc )

virtualinherited

getHomogeneousBc()

virtual bool IBTK::GeneralOperator::getHomogeneousBc ( ) const

virtualinherited

setSolutionTime()

virtual void IBTK::GeneralOperator::setSolutionTime ( double  solution_time )

virtualinherited

getSolutionTime()

virtual double IBTK::GeneralOperator::getSolutionTime ( ) const

virtualinherited

setTimeInterval()

virtual void IBTK::GeneralOperator::setTimeInterval ( double  current_time, double  new_time  )

virtualinherited

getTimeInterval()

virtual std::pair<double, double> IBTK::GeneralOperator::getTimeInterval ( ) const

virtualinherited

getDt()

virtual double IBTK::GeneralOperator::getDt ( ) const

virtualinherited

setHierarchyMathOps()

virtual void IBTK::GeneralOperator::setHierarchyMathOps ( SAMRAI::tbox::Pointer< HierarchyMathOps >  hier_math_ops )

virtualinherited

getHierarchyMathOps()

virtual SAMRAI::tbox::Pointer<HierarchyMathOps> IBTK::GeneralOperator::getHierarchyMathOps ( ) const

virtualinherited

applyAdd()

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

virtualinherited

Before calling applyAdd(), the form of the vectors x, y, and z should be set properly by the user on all patch interiors on the specified range of levels in the patch hierarchy. The user is responsible for all data management for the quantities associated with the vectors. In particular, patch data in these vectors must be allocated prior to calling this method.

Parameters

x	input vector
y	input vector
z	output vector, i.e., \(z=F[x]+y\)

Conditions on Parameters:

• vectors x, y, and z must have same hierarchy
• vectors x, y, and z must have same structure, depth, etc.

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

Note

Subclasses may require that the operator be initialized prior to calling applyAdd().

See also

initializeOperatorState

Note

A default implementation is provided which employs apply() and SAMRAI::solv::SAMRAIVectorReal::add().

Reimplemented in IBTK::PETScSNESJacobianJOWrapper, and IBTK::PETScMatLOWrapper.

initializeOperatorState()

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

virtualinherited

The vector arguments for apply(), applyAdd(), etc, need not match those for initializeOperatorState(). However, there must be a certain degree of similarity, including

• hierarchy configuration (hierarchy pointer and level range)
• number, type and alignment of vector component data
• ghost cell widths of data in the input and output vectors

Note

It is generally necessary to reinitialize the operator state when the hierarchy configuration changes.

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:

• input and output vectors must have same hierarchy
• input and output vectors must have same structure, depth, etc.

Call deallocateOperatorState() to remove any data allocated by this method.

See also

deallocateOperatorState

Parameters

in	input vector
out	output vector

Reimplemented in IBTK::PETScSNESJacobianJOWrapper, IBAMR::AdvDiffWavePropConvectiveOperator, IBTK::PETScMatLOWrapper, IBTK::PETScMFFDJacobianOperator, IBTK::PETScSNESFunctionGOWrapper, IBAMR::INSCollocatedPPMConvectiveOperator, IBAMR::CellConvectiveOperator, IBAMR::INSStaggeredCUIConvectiveOperator, IBAMR::INSCollocatedCenteredConvectiveOperator, IBAMR::INSStaggeredWavePropConvectiveOperator, IBAMR::INSStaggeredStabilizedPPMConvectiveOperator, IBAMR::INSCollocatedWavePropConvectiveOperator, IBAMR::INSStaggeredPPMConvectiveOperator, IBAMR::INSStaggeredCenteredConvectiveOperator, IBAMR::INSStaggeredUpwindConvectiveOperator, IBAMR::CFUpperConvectiveOperator, IBTK::SCLaplaceOperator, IBTK::CCLaplaceOperator, IBTK::VCSCViscousOperator, and IBAMR::CIBStaggeredStokesOperator.

deallocateOperatorState()

virtual void IBTK::GeneralOperator::deallocateOperatorState ( )

virtualinherited

Note

Subclasses are required to be implemented so that it is safe to call deallocateOperatorState() when the operator state is already deallocated.

See also

initializeOperatorState

Reimplemented in IBTK::PETScSNESJacobianJOWrapper, IBAMR::AdvDiffWavePropConvectiveOperator, IBTK::PETScMatLOWrapper, IBTK::PETScMFFDJacobianOperator, IBTK::PETScSNESFunctionGOWrapper, IBAMR::INSCollocatedPPMConvectiveOperator, IBAMR::INSStaggeredCUIConvectiveOperator, IBAMR::INSCollocatedCenteredConvectiveOperator, IBAMR::INSStaggeredWavePropConvectiveOperator, IBAMR::INSStaggeredStabilizedPPMConvectiveOperator, IBAMR::CellConvectiveOperator, IBAMR::INSCollocatedWavePropConvectiveOperator, IBAMR::INSStaggeredPPMConvectiveOperator, IBAMR::INSStaggeredCenteredConvectiveOperator, IBAMR::INSStaggeredUpwindConvectiveOperator, IBAMR::CFUpperConvectiveOperator, IBTK::SCLaplaceOperator, IBTK::CCLaplaceOperator, IBTK::VCSCViscousOperator, and IBAMR::CIBStaggeredStokesOperator.

modifyRhsForBcs()

virtual void IBTK::GeneralOperator::modifyRhsForBcs ( SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &  y )

virtualinherited

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

Note

The operator MUST be initialized prior to calling modifyRhsForBcs.

See also

initializeOperatorState

Note

A default implementation does not modify the RHS vector y.

Reimplemented in IBTK::LinearOperator.

imposeSolBcs()

virtual void IBTK::GeneralOperator::imposeSolBcs ( SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &  u )

virtualinherited

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

Note

The operator MUST be initialized prior to calling imposeSolBcs.

See also

initializeOperatorState

Note

A default implementation does not modify the sol vector u.

setLoggingEnabled()

virtual void IBTK::GeneralOperator::setLoggingEnabled ( bool  enable_logging = true )

virtualinherited

getLoggingEnabled()

virtual bool IBTK::GeneralOperator::getLoggingEnabled ( ) const

virtualinherited

printClassData()

virtual void IBTK::GeneralOperator::printClassData ( std::ostream &  stream )

virtualinherited

Member Data Documentation

d_difference_form

ConvectiveDifferencingType IBAMR::ConvectiveOperator::d_difference_form

protected

Enumerated type that determines which form of differencing to use.

d_u_idx

int IBAMR::ConvectiveOperator::d_u_idx = IBTK::invalid_index

protected

The advection velocity patch data descriptor index.

d_object_name

const std::string IBTK::GeneralOperator::d_object_name

protectedinherited

d_is_initialized

bool IBTK::GeneralOperator::d_is_initialized = false

protectedinherited

d_homogeneous_bc

bool IBTK::GeneralOperator::d_homogeneous_bc

protectedinherited

d_solution_time

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

protectedinherited

d_current_time

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

protectedinherited

d_new_time

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

protectedinherited

d_hier_math_ops

SAMRAI::tbox::Pointer<HierarchyMathOps> IBTK::GeneralOperator::d_hier_math_ops

protectedinherited

d_hier_math_ops_external

bool IBTK::GeneralOperator::d_hier_math_ops_external = false

protectedinherited

d_enable_logging

bool IBTK::GeneralOperator::d_enable_logging = false

protectedinherited

---

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

• include/ibamr/ConvectiveOperator.h