Class PoissonUtilities provides utility functions for constructing Poisson solvers.

#include <ibtk/PoissonUtilities.h>

Static Public Member Functions
static void	computeMatrixCoefficients (SAMRAI::pdat::CellData< NDIM, double > &matrix_coefficients, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const std::vector< SAMRAI::hier::Index< NDIM >> &stencil, const SAMRAI::solv::PoissonSpecifications &poisson_spec, SAMRAI::solv::RobinBcCoefStrategy< NDIM > *bc_coef, double data_time)

static void	computeMatrixCoefficients (SAMRAI::pdat::CellData< NDIM, double > &matrix_coefficients, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const std::vector< SAMRAI::hier::Index< NDIM >> &stencil, const SAMRAI::solv::PoissonSpecifications &poisson_spec, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &bc_coefs, double data_time)

static void	computeMatrixCoefficients (SAMRAI::pdat::SideData< NDIM, double > &matrix_coefficients, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const std::vector< SAMRAI::hier::Index< NDIM >> &stencil, const SAMRAI::solv::PoissonSpecifications &poisson_spec, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &bc_coefs, double data_time)

static void	computeVCSCViscousOpMatrixCoefficients (SAMRAI::pdat::SideData< NDIM, double > &matrix_coefficients, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const std::vector< std::map< SAMRAI::hier::Index< NDIM >, int, IndexFortranOrder >> &stencil_map_vec, const SAMRAI::solv::PoissonSpecifications &poisson_spec, double alpha, double beta, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &bc_coefs, double data_time, VCInterpType mu_interp_type=VC_HARMONIC_INTERP)

static void	adjustRHSAtPhysicalBoundary (SAMRAI::pdat::CellData< NDIM, double > &rhs_data, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const SAMRAI::solv::PoissonSpecifications &poisson_spec, SAMRAI::solv::RobinBcCoefStrategy< NDIM > *bc_coef, double data_time, bool homogeneous_bc)

static void	adjustRHSAtPhysicalBoundary (SAMRAI::pdat::CellData< NDIM, double > &rhs_data, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const SAMRAI::solv::PoissonSpecifications &poisson_spec, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &bc_coefs, double data_time, bool homogeneous_bc)

static void	adjustRHSAtPhysicalBoundary (SAMRAI::pdat::SideData< NDIM, double > &rhs_data, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const SAMRAI::solv::PoissonSpecifications &poisson_spec, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &bc_coefs, double data_time, bool homogeneous_bc)

static void	adjustVCSCViscousOpRHSAtPhysicalBoundary (SAMRAI::pdat::SideData< NDIM, double > &rhs_data, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const SAMRAI::solv::PoissonSpecifications &poisson_spec, double alpha, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &bc_coefs, double data_time, bool homogeneous_bc, VCInterpType mu_interp_type=VC_HARMONIC_INTERP)

static void	adjustRHSAtCoarseFineBoundary (SAMRAI::pdat::CellData< NDIM, double > &rhs_data, const SAMRAI::pdat::CellData< NDIM, double > &sol_data, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const SAMRAI::solv::PoissonSpecifications &poisson_spec, const SAMRAI::tbox::Array< SAMRAI::hier::BoundaryBox< NDIM >> &type1_cf_bdry)

static void	adjustRHSAtCoarseFineBoundary (SAMRAI::pdat::SideData< NDIM, double > &rhs_data, const SAMRAI::pdat::SideData< NDIM, double > &sol_data, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const SAMRAI::solv::PoissonSpecifications &poisson_spec, const SAMRAI::tbox::Array< SAMRAI::hier::BoundaryBox< NDIM >> &type1_cf_bdry, const SAMRAI::tbox::Array< SAMRAI::hier::BoundaryBox< NDIM >> &type2_cf_bdry, const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &bc_coefs, double data_time, bool homogeneous_bc)

static void	adjustVCSCViscousOpRHSAtCoarseFineBoundary (SAMRAI::pdat::SideData< NDIM, double > &rhs_data, const SAMRAI::pdat::SideData< NDIM, double > &sol_data, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >> patch, const SAMRAI::solv::PoissonSpecifications &poisson_spec, double alpha, const SAMRAI::tbox::Array< SAMRAI::hier::BoundaryBox< NDIM >> &type1_cf_bdry, VCInterpType mu_interp_type=VC_HARMONIC_INTERP)

Private Member Functions
	PoissonUtilities ()=delete
	Default constructor. More...

	PoissonUtilities (const PoissonUtilities &from)=delete
	Copy constructor. More...

PoissonUtilities &	operator= (const PoissonUtilities &that)=delete
	Assignment operator. More...

Constructor & Destructor Documentation

◆ PoissonUtilities() [1/2]

IBTK::PoissonUtilities::PoissonUtilities ( )

privatedelete

Note: This constructor is not implemented and should not be used.

◆ PoissonUtilities() [2/2]

IBTK::PoissonUtilities::PoissonUtilities ( const PoissonUtilities & 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

◆ computeMatrixCoefficients() [1/3]

static void IBTK::PoissonUtilities::computeMatrixCoefficients	(	SAMRAI::pdat::CellData< NDIM, double > &	matrix_coefficients,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const std::vector< SAMRAI::hier::Index< NDIM >> &	stencil,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		SAMRAI::solv::RobinBcCoefStrategy< NDIM > *	bc_coef,
		double	data_time
	)

static

Compute the matrix coefficients corresponding to a cell-centered discretization of the Laplacian.

◆ computeMatrixCoefficients() [2/3]

static void IBTK::PoissonUtilities::computeMatrixCoefficients	(	SAMRAI::pdat::CellData< NDIM, double > &	matrix_coefficients,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const std::vector< SAMRAI::hier::Index< NDIM >> &	stencil,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	bc_coefs,
		double	data_time
	)

static

Compute the matrix coefficients corresponding to a cell-centered discretization of the Laplacian.

◆ computeMatrixCoefficients() [3/3]

static void IBTK::PoissonUtilities::computeMatrixCoefficients	(	SAMRAI::pdat::SideData< NDIM, double > &	matrix_coefficients,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const std::vector< SAMRAI::hier::Index< NDIM >> &	stencil,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	bc_coefs,
		double	data_time
	)

static

Compute the matrix coefficients corresponding to a side-centered discretization of the Laplacian.

◆ computeVCSCViscousOpMatrixCoefficients()

static void IBTK::PoissonUtilities::computeVCSCViscousOpMatrixCoefficients	(	SAMRAI::pdat::SideData< NDIM, double > &	matrix_coefficients,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const std::vector< std::map< SAMRAI::hier::Index< NDIM >, int, IndexFortranOrder >> &	stencil_map_vec,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		double	alpha,
		double	beta,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	bc_coefs,
		double	data_time,
		VCInterpType	mu_interp_type = `VC_HARMONIC_INTERP`
	)

static

Compute the matrix coefficients corresponding to a side-centered discretization of the divergence of the viscous stress tensor.

Note: The scaling factors of \( C \) and \( D \) variables in the PoissonSpecification object are passed separately and are denoted by \( \beta \) and \( \alpha \), respectively.

◆ adjustRHSAtPhysicalBoundary() [1/3]

static void IBTK::PoissonUtilities::adjustRHSAtPhysicalBoundary	(	SAMRAI::pdat::CellData< NDIM, double > &	rhs_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		SAMRAI::solv::RobinBcCoefStrategy< NDIM > *	bc_coef,
		double	data_time,
		bool	homogeneous_bc
	)

static

Modify the right-hand side entries to account for physical boundary conditions corresponding to a cell-centered discretization of the Laplacian.

◆ adjustRHSAtPhysicalBoundary() [2/3]

static void IBTK::PoissonUtilities::adjustRHSAtPhysicalBoundary	(	SAMRAI::pdat::CellData< NDIM, double > &	rhs_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	bc_coefs,
		double	data_time,
		bool	homogeneous_bc
	)

static

Modify the right-hand side entries to account for physical boundary conditions corresponding to a cell-centered discretization of the Laplacian.

◆ adjustRHSAtPhysicalBoundary() [3/3]

static void IBTK::PoissonUtilities::adjustRHSAtPhysicalBoundary	(	SAMRAI::pdat::SideData< NDIM, double > &	rhs_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	bc_coefs,
		double	data_time,
		bool	homogeneous_bc
	)

static

Modify the right-hand side entries to account for physical boundary conditions corresponding to a side-centered discretization of the Laplacian.

◆ adjustVCSCViscousOpRHSAtPhysicalBoundary()

static void IBTK::PoissonUtilities::adjustVCSCViscousOpRHSAtPhysicalBoundary	(	SAMRAI::pdat::SideData< NDIM, double > &	rhs_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		double	alpha,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	bc_coefs,
		double	data_time,
		bool	homogeneous_bc,
		VCInterpType	mu_interp_type = `VC_HARMONIC_INTERP`
	)

static

Modify the right-hand side entries to account for physical boundary conditions corresponding to a side-centered discretization of the variable-coefficient viscous operator.

Note: The scaling factors of \( D \) variable in the PoissonSpecification object is passed separately and is denoted \( \alpha \).

◆ adjustRHSAtCoarseFineBoundary() [1/2]

static void IBTK::PoissonUtilities::adjustRHSAtCoarseFineBoundary	(	SAMRAI::pdat::CellData< NDIM, double > &	rhs_data,
		const SAMRAI::pdat::CellData< NDIM, double > &	sol_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		const SAMRAI::tbox::Array< SAMRAI::hier::BoundaryBox< NDIM >> &	type1_cf_bdry
	)

static

Modify the right-hand side entries to account for coarse-fine interface boundary conditions corresponding to a cell-centered discretization of the Laplacian.

Note: This function simply uses ghost cell values in sol_data to provide Dirichlet boundary values at coarse-fine interfaces. A more complete implementation would employ the interpolation stencil used at coarse-fine interfaces to modify both the matrix coefficients and RHS values at coarse-fine interfaces.

◆ adjustRHSAtCoarseFineBoundary() [2/2]

static void IBTK::PoissonUtilities::adjustRHSAtCoarseFineBoundary	(	SAMRAI::pdat::SideData< NDIM, double > &	rhs_data,
		const SAMRAI::pdat::SideData< NDIM, double > &	sol_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		const SAMRAI::tbox::Array< SAMRAI::hier::BoundaryBox< NDIM >> &	type1_cf_bdry,
		const SAMRAI::tbox::Array< SAMRAI::hier::BoundaryBox< NDIM >> &	type2_cf_bdry,
		const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	bc_coefs,
		double	data_time,
		bool	homogeneous_bc
	)

static

Modify the right-hand side entries to account for coarse-fine interface boundary conditions corresponding to a side-centered discretization of the Laplacian.

For each side of the patch, this function subtracts from the right-hand side the contribution of each stencil neighbor that is not a side of any patch of the level, using the ghost values in sol_data; neighbors across a physical boundary contribute nothing. It modifies only rhs_data in the side box of the patch, so rhs_data needs no ghost cells.

The boundary boxes of codimension 2 (the corner cells in 2D and the edge cells in 3D) determine which ghost cells that touch the patch only along an edge or a corner belong to the level. This function does not modify the entries of the sides on a physical boundary normal to their component at which the coefficient b of bc_coefs is exactly zero, because such an entry is the Dirichlet value. It evaluates the coefficients as adjustRHSAtPhysicalBoundary() does.

Note: This function simply uses ghost cell values in sol_data to provide Dirichlet boundary values at coarse-fine interfaces. A more complete implementation would employ the interpolation stencil used at coarse-fine interfaces to modify both the matrix coefficients and RHS values at coarse-fine interfaces.

◆ adjustVCSCViscousOpRHSAtCoarseFineBoundary()

static void IBTK::PoissonUtilities::adjustVCSCViscousOpRHSAtCoarseFineBoundary	(	SAMRAI::pdat::SideData< NDIM, double > &	rhs_data,
		const SAMRAI::pdat::SideData< NDIM, double > &	sol_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM >>	patch,
		const SAMRAI::solv::PoissonSpecifications &	poisson_spec,
		double	alpha,
		const SAMRAI::tbox::Array< SAMRAI::hier::BoundaryBox< NDIM >> &	type1_cf_bdry,
		VCInterpType	mu_interp_type = `VC_HARMONIC_INTERP`
	)

static

Modify the right-hand side entries to account for coarse-fine interface boundary conditions corresponding to a side-centered discretization of the variable coefficient viscous operator.

Note: This function simply uses ghost cell values in sol_data to provide Dirichlet boundary values at coarse-fine interfaces. A more complete implementation would employ the interpolation stencil used at coarse-fine interfaces to modify both the matrix coefficients and RHS values at coarse-fine interfaces.; The scaling factors of \( D \) variable in the PoissonSpecification object is passed separately and is denoted \( \alpha \).

◆ operator=()

PoissonUtilities& IBTK::PoissonUtilities::operator= ( const PoissonUtilities & 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.

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

ibtk/include/ibtk/PoissonUtilities.h

Static Public Member Functions

Private Member Functions

Constructor & Destructor Documentation

◆ PoissonUtilities() [1/2]

◆ PoissonUtilities() [2/2]

Member Function Documentation

◆ computeMatrixCoefficients() [1/3]

◆ computeMatrixCoefficients() [2/3]

◆ computeMatrixCoefficients() [3/3]

◆ computeVCSCViscousOpMatrixCoefficients()

◆ adjustRHSAtPhysicalBoundary() [1/3]

◆ adjustRHSAtPhysicalBoundary() [2/3]

◆ adjustRHSAtPhysicalBoundary() [3/3]

◆ adjustVCSCViscousOpRHSAtPhysicalBoundary()

◆ adjustRHSAtCoarseFineBoundary() [1/2]

◆ adjustRHSAtCoarseFineBoundary() [2/2]

◆ adjustVCSCViscousOpRHSAtCoarseFineBoundary()

◆ operator=()