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

#include </home/runner/work/IBAMR/IBAMR/include/ibamr/ConvectiveOperator.h>

Inheritance diagram for IBAMR::ConvectiveOperator:

[legend]

Public Member Functions
	ConvectiveOperator (std::string object_name, ConvectiveDifferencingType difference_form)
	Class constructor.

	~ConvectiveOperator ()
	Destructor.

void	setAdvectionVelocity (int u_idx)
	Set the patch data index corresponding to the advection velocity to be used when computing the convective derivative.

int	getAdvectionVelocity () const
	Get the patch data index corresponding to the advection velocity used when computing the convective derivative.

void	setConvectiveDifferencingType (ConvectiveDifferencingType difference_form)
	Set the convective differencing form to be used by the operator.

ConvectiveDifferencingType	getConvectiveDifferencingType () const
	Get the convective differencing form used by the operator.

virtual void	applyConvectiveOperator (int Q_idx, int N_idx)=0
	Compute N = u * grad Q.

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

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 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 . 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 ConvectiveOperator is a abstract class for an implementation of a convective differencing operator.

Member Function Documentation

◆ apply()

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

overridevirtual

Compute $y=F[x]$ .

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

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.

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.

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

/home/runner/work/IBAMR/IBAMR/include/ibamr/ConvectiveOperator.h
/home/runner/work/IBAMR/IBAMR/src/utilities/ConvectiveOperator.cpp

Public Member Functions