Class CFUpperConvectiveOperator is a concrete ConvectiveOperator that implements the upper convective derivative. This uses second order finite differences to compute the velocity gradients. The transport component can be chosen from any current convective operators. If the advected quantity allows for a square root or logarithmic decomposition, this class can advect the symmetric square root or logarithm of the tensor. Note that this class requires the registration of a source funtion before it can be applied.

#include <ibamr/CFUpperConvectiveOperator.h>

Inheritance diagram for IBAMR::CFUpperConvectiveOperator:

[legend]

Public Member Functions
	CFUpperConvectiveOperator (const std::string &object_name, SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > Q_var, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, const std::string &convective_op_type, ConvectiveDifferencingType difference_type, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &Q_bc_coefs, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &u_bc_coefs)

	CFUpperConvectiveOperator (const std::string &object_name, SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > Q_var, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, SAMRAI::tbox::Pointer< ConvectiveOperator > convective_op, ConvectiveDifferencingType difference_type, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &Q_bc_coefs, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &u_bc_coefs)

	CFUpperConvectiveOperator ()=delete

	CFUpperConvectiveOperator (const CFUpperConvectiveOperator &from)=delete

CFUpperConvectiveOperator &	operator= (const CFUpperConvectiveOperator &that)=delete

	~CFUpperConvectiveOperator ()

void	applyConvectiveOperator (int Q_idx, int Y_idx) override
	Compute N = u * grad Q. 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=F[x] and z=F[x]+y. More...

void	deallocateOperatorState () override
	Remove all hierarchy dependent data allocated by initializeOperatorState(). More...

void	registerCFStrategy (SAMRAI::tbox::Pointer< IBAMR::CFStrategy > cf_strategy)
	: Registers a source function with the convective operator. Note that this source function is given the evolved version of the tensor, and therefore must first be converted from the square root or logarithm to the tensor. 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...

Private Member Functions
void	commonConstructor (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db)

Private Attributes
SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	d_hierarchy

int	d_coarsest_ln = IBTK::invalid_level_number

int	d_finest_ln = IBTK::invalid_level_number

SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > >	d_Q_var

SAMRAI::tbox::Pointer< SAMRAI::pdat::SideVariable< NDIM, double > >	d_u_adv_var

int	d_u_scratch_idx = IBTK::invalid_index

SAMRAI::tbox::Pointer< IBAMR::CFStrategy >	d_cf_strategy

int	d_s_idx = IBTK::invalid_index

SAMRAI::tbox::Pointer< IBAMR::ConvectiveOperator >	d_convec_oper

int	d_Q_convec_idx = IBTK::invalid_index

const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * >	d_Q_bc_coefs

const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * >	d_u_bc_coefs

TensorEvolutionType	d_evolve_type = STANDARD

std::string	d_interp_type = "LINEAR"

General operator functionality.
void	apply (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &y) override
	Compute \(y=F[x]\). More...

ConvectiveDifferencingType	d_difference_form

int	d_u_idx = IBTK::invalid_index

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

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

Constructor & Destructor Documentation

◆ CFUpperConvectiveOperator() [1/4]

IBAMR::CFUpperConvectiveOperator::CFUpperConvectiveOperator	(	const std::string &	object_name,
		SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > >	Q_var,
		SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	input_db,
		const std::string &	convective_op_type,
		ConvectiveDifferencingType	difference_type,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	Q_bc_coefs,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	u_bc_coefs
	)

Constructor that takes in a string for the convective operator. The convective operator type must be one of "DEFAULT", "CENTERED", "CUI", "PPM", or "WAVE_PROP"

◆ CFUpperConvectiveOperator() [2/4]

IBAMR::CFUpperConvectiveOperator::CFUpperConvectiveOperator	(	const std::string &	object_name,
		SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > >	Q_var,
		SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	input_db,
		SAMRAI::tbox::Pointer< ConvectiveOperator >	convective_op,
		ConvectiveDifferencingType	difference_type,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	Q_bc_coefs,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	u_bc_coefs
	)

Constructor that takes in a convective operator

◆ CFUpperConvectiveOperator() [3/4]

IBAMR::CFUpperConvectiveOperator::CFUpperConvectiveOperator ( )

delete

◆ CFUpperConvectiveOperator() [4/4]

IBAMR::CFUpperConvectiveOperator::CFUpperConvectiveOperator ( const CFUpperConvectiveOperator & from )

delete

◆ ~CFUpperConvectiveOperator()

IBAMR::CFUpperConvectiveOperator::~CFUpperConvectiveOperator ( )

Member Function Documentation

◆ operator=()

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

delete

◆ applyConvectiveOperator()

void IBAMR::CFUpperConvectiveOperator::applyConvectiveOperator	(	int	Q_idx,
		int	N_idx
	)

overridevirtual

Implements IBAMR::ConvectiveOperator.

◆ initializeOperatorState()

void IBAMR::CFUpperConvectiveOperator::initializeOperatorState	(	const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	in,
		const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	out
	)

overridevirtual

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 from IBTK::GeneralOperator.

◆ deallocateOperatorState()

void IBAMR::CFUpperConvectiveOperator::deallocateOperatorState ( )

overridevirtual

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 from IBTK::GeneralOperator.

◆ registerCFStrategy()

void IBAMR::CFUpperConvectiveOperator::registerCFStrategy ( SAMRAI::tbox::Pointer< IBAMR::CFStrategy > cf_strategy )

◆ commonConstructor()

void IBAMR::CFUpperConvectiveOperator::commonConstructor ( SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db )

private

◆ setAdvectionVelocity()

void IBAMR::ConvectiveOperator::setAdvectionVelocity ( int u_idx )

inherited

◆ getAdvectionVelocity()

int IBAMR::ConvectiveOperator::getAdvectionVelocity ( ) const

inherited

◆ setConvectiveDifferencingType()

void IBAMR::ConvectiveOperator::setConvectiveDifferencingType ( ConvectiveDifferencingType difference_form )

inherited

◆ getConvectiveDifferencingType()

ConvectiveDifferencingType IBAMR::ConvectiveOperator::getConvectiveDifferencingType ( ) const

inherited

◆ apply()

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

overridevirtualinherited

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.

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

◆ 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_hierarchy

SAMRAI::tbox::Pointer<SAMRAI::hier::PatchHierarchy<NDIM> > IBAMR::CFUpperConvectiveOperator::d_hierarchy

private

◆ d_coarsest_ln

int IBAMR::CFUpperConvectiveOperator::d_coarsest_ln = IBTK::invalid_level_number

private

◆ d_finest_ln

int IBAMR::CFUpperConvectiveOperator::d_finest_ln = IBTK::invalid_level_number

private

◆ d_Q_var

SAMRAI::tbox::Pointer<SAMRAI::pdat::CellVariable<NDIM, double> > IBAMR::CFUpperConvectiveOperator::d_Q_var

private

◆ d_u_adv_var

SAMRAI::tbox::Pointer<SAMRAI::pdat::SideVariable<NDIM, double> > IBAMR::CFUpperConvectiveOperator::d_u_adv_var

private

◆ d_u_scratch_idx

int IBAMR::CFUpperConvectiveOperator::d_u_scratch_idx = IBTK::invalid_index

private

◆ d_cf_strategy

SAMRAI::tbox::Pointer<IBAMR::CFStrategy> IBAMR::CFUpperConvectiveOperator::d_cf_strategy

private

◆ d_s_idx

int IBAMR::CFUpperConvectiveOperator::d_s_idx = IBTK::invalid_index

private

◆ d_convec_oper

SAMRAI::tbox::Pointer<IBAMR::ConvectiveOperator> IBAMR::CFUpperConvectiveOperator::d_convec_oper

private

◆ d_Q_convec_idx

int IBAMR::CFUpperConvectiveOperator::d_Q_convec_idx = IBTK::invalid_index

private

◆ d_Q_bc_coefs

const std::vector<SAMRAI::solv::RobinBcCoefStrategy<NDIM>*> IBAMR::CFUpperConvectiveOperator::d_Q_bc_coefs

private

◆ d_u_bc_coefs

const std::vector<SAMRAI::solv::RobinBcCoefStrategy<NDIM>*> IBAMR::CFUpperConvectiveOperator::d_u_bc_coefs

private

◆ d_evolve_type

TensorEvolutionType IBAMR::CFUpperConvectiveOperator::d_evolve_type = STANDARD

private

◆ d_interp_type

std::string IBAMR::CFUpperConvectiveOperator::d_interp_type = "LINEAR"

private

◆ d_difference_form

ConvectiveDifferencingType IBAMR::ConvectiveOperator::d_difference_form

protectedinherited

Enumerated type that determines which form of differencing to use.

◆ d_u_idx

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

protectedinherited

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/CFUpperConvectiveOperator.h

Public Member Functions

Private Member Functions

Private Attributes

General operator functionality.

General operator functionality.

Logging functions.

Constructor & Destructor Documentation

◆ CFUpperConvectiveOperator() [1/4]

◆ CFUpperConvectiveOperator() [2/4]

◆ CFUpperConvectiveOperator() [3/4]

◆ CFUpperConvectiveOperator() [4/4]

◆ ~CFUpperConvectiveOperator()

Member Function Documentation

◆ operator=()

◆ applyConvectiveOperator()

◆ initializeOperatorState()

◆ deallocateOperatorState()

◆ registerCFStrategy()

◆ commonConstructor()

◆ setAdvectionVelocity()

◆ getAdvectionVelocity()

◆ setConvectiveDifferencingType()

◆ getConvectiveDifferencingType()

◆ apply()

◆ getName()

◆ getIsInitialized()

◆ setHomogeneousBc()

◆ getHomogeneousBc()

◆ setSolutionTime()

◆ getSolutionTime()

◆ setTimeInterval()

◆ getTimeInterval()

◆ getDt()

◆ setHierarchyMathOps()

◆ getHierarchyMathOps()

◆ applyAdd()

◆ modifyRhsForBcs()

◆ imposeSolBcs()

◆ setLoggingEnabled()

◆ getLoggingEnabled()

◆ printClassData()

Member Data Documentation

◆ d_hierarchy

◆ d_coarsest_ln

◆ d_finest_ln

◆ d_Q_var

◆ d_u_adv_var

◆ d_u_scratch_idx

◆ d_cf_strategy

◆ d_s_idx

◆ d_convec_oper

◆ d_Q_convec_idx

◆ d_Q_bc_coefs

◆ d_u_bc_coefs

◆ d_evolve_type

◆ d_interp_type

◆ d_difference_form

◆ d_u_idx

◆ d_object_name

◆ d_is_initialized

◆ d_homogeneous_bc

◆ d_solution_time

◆ d_current_time

◆ d_new_time

◆ d_hier_math_ops

◆ d_hier_math_ops_external

◆ d_enable_logging