IBAMR::SpongeLayerForceFunction Class Reference

Class SpongeLayerForceFunction provides forcing at physical boundaries that weakly imposes homogeneous Dirichlet boundary conditions.

#include <ibamr/SpongeLayerForceFunction.h>

Inheritance diagram for IBAMR::SpongeLayerForceFunction:

Public Member Functions
	SpongeLayerForceFunction (const std::string &object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, const INSHierarchyIntegrator *fluid_solver, SAMRAI::tbox::Pointer< SAMRAI::geom::CartesianGridGeometry< NDIM > > grid_geometry)
	Constructor. More...
	~SpongeLayerForceFunction ()=default
	Destructor. More...

Methods to set the data.
std::array< SAMRAI::tbox::Array< bool >, 2 *NDIM >	d_forcing_enabled
std::array< double, 2 *NDIM >	d_width
const INSHierarchyIntegrator *const	d_fluid_solver
SAMRAI::tbox::Pointer< SAMRAI::geom::CartesianGridGeometry< NDIM > >	d_grid_geometry
bool	isTimeDependent () const override
void	setDataOnPatch (int data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > var, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch, double data_time, bool initial_time=false, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > > level=SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > >(nullptr)) override
	SpongeLayerForceFunction ()=delete
	Default constructor. More...
	SpongeLayerForceFunction (const SpongeLayerForceFunction &from)=delete
	Copy constructor. More...
SpongeLayerForceFunction &	operator= (const SpongeLayerForceFunction &that)=delete
	Assignment operator. More...
void	setDataOnPatchCell (SAMRAI::tbox::Pointer< SAMRAI::pdat::CellData< NDIM, double > > F_data, SAMRAI::tbox::Pointer< SAMRAI::pdat::CellData< NDIM, double > > U_current_data, SAMRAI::tbox::Pointer< SAMRAI::pdat::CellData< NDIM, double > > U_new_data, double kappa, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch)
void	setDataOnPatchSide (SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, double > > F_data, SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, double > > U_current_data, SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, double > > U_new_data, double kappa, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch)

Methods to set patch interior data.
virtual void	setDataOnPatchHierarchy (int data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > var, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, double data_time, bool initial_time=false, int coarsest_ln=invalid_level_number, int finest_ln=invalid_level_number)
	Evaluate the function on the patch interiors on the specified levels of the patch hierarchy using the virtual function setDataOnPatch(). More...
virtual void	setDataOnPatchLevel (int data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > var, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > > patch_level, double data_time, bool initial_time=false)
	Evaluate the function on the patch interiors on the specified level of the patch hierarchy using the virtual function setDataOnPatch(). More...
std::string	d_object_name

Constructor & Destructor Documentation

SpongeLayerForceFunction() [1/3]

IBAMR::SpongeLayerForceFunction::SpongeLayerForceFunction	(	const std::string &	object_name,
		SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	input_db,
		const INSHierarchyIntegrator *	fluid_solver,
		SAMRAI::tbox::Pointer< SAMRAI::geom::CartesianGridGeometry< NDIM > >	grid_geometry
	)

~SpongeLayerForceFunction()

IBAMR::SpongeLayerForceFunction::~SpongeLayerForceFunction ( )

default

SpongeLayerForceFunction() [2/3]

IBAMR::SpongeLayerForceFunction::SpongeLayerForceFunction ( )

privatedelete

Note

This constructor is not implemented and should not be used.

SpongeLayerForceFunction() [3/3]

IBAMR::SpongeLayerForceFunction::SpongeLayerForceFunction ( const SpongeLayerForceFunction &  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

isTimeDependent()

bool IBAMR::SpongeLayerForceFunction::isTimeDependent ( ) const

overridevirtual

Note

This concrete IBTK::CartGridFunction is time-dependent.

Implements IBTK::CartGridFunction.

setDataOnPatch()

void IBAMR::SpongeLayerForceFunction::setDataOnPatch ( int  data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > >  var, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > >  patch, double  data_time, bool  initial_time = false, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > >  level = SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > >(nullptr)  )

overridevirtual

Set the data on the patch interior.

Implements IBTK::CartGridFunction.

operator=()

SpongeLayerForceFunction& IBAMR::SpongeLayerForceFunction::operator= ( const SpongeLayerForceFunction &  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.

setDataOnPatchCell()

void IBAMR::SpongeLayerForceFunction::setDataOnPatchCell ( SAMRAI::tbox::Pointer< SAMRAI::pdat::CellData< NDIM, double > >  F_data, SAMRAI::tbox::Pointer< SAMRAI::pdat::CellData< NDIM, double > >  U_current_data, SAMRAI::tbox::Pointer< SAMRAI::pdat::CellData< NDIM, double > >  U_new_data, double  kappa, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > >  patch  )

private

Set the data on the patch interior.

setDataOnPatchSide()

void IBAMR::SpongeLayerForceFunction::setDataOnPatchSide ( SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, double > >  F_data, SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, double > >  U_current_data, SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, double > >  U_new_data, double  kappa, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > >  patch  )

private

Set the data on the patch interior.

setDataOnPatchHierarchy()

virtual void IBTK::CartGridFunction::setDataOnPatchHierarchy ( int  data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > >  var, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >  hierarchy, double  data_time, bool  initial_time = false, int  coarsest_ln = invalid_level_number, int  finest_ln = invalid_level_number  )

virtualinherited

See also

setDataOnPatch

Reimplemented in IBTK::CartGridFunctionSet, IBAMR::SurfaceTensionForceFunction, IBAMR::MarangoniSurfaceTensionForceFunction, IBAMR::PhaseChangeDivUSourceFunction, IBAMR::HeavisideForcingFunction, IBAMR::IBHierarchyIntegrator::IBEulerianSourceFunction, IBAMR::IBHierarchyIntegrator::IBEulerianForceFunction, IBAMR::CFINSForcing, IBAMR::INSStaggeredStochasticForcing, and IBAMR::AdvDiffStochasticForcing.

setDataOnPatchLevel()

virtual void IBTK::CartGridFunction::setDataOnPatchLevel ( int  data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > >  var, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > >  patch_level, double  data_time, bool  initial_time = false  )

virtualinherited

See also

setDataOnPatch

Reimplemented in IBTK::CartGridFunctionSet, and IBAMR::CFINSForcing.

Member Data Documentation

d_forcing_enabled

std::array<SAMRAI::tbox::Array<bool>, 2 * NDIM> IBAMR::SpongeLayerForceFunction::d_forcing_enabled

private

d_width

std::array<double, 2 * NDIM> IBAMR::SpongeLayerForceFunction::d_width

private

d_fluid_solver

const INSHierarchyIntegrator* const IBAMR::SpongeLayerForceFunction::d_fluid_solver

private

d_grid_geometry

SAMRAI::tbox::Pointer<SAMRAI::geom::CartesianGridGeometry<NDIM> > IBAMR::SpongeLayerForceFunction::d_grid_geometry

private

d_object_name

std::string IBTK::CartGridFunction::d_object_name

protectedinherited

---

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

• include/ibamr/SpongeLayerForceFunction.h