BoundaryConditionParameters Class Reference

#include <BoundaryConditionParameters.h>

Public Types
enum	CornerBoundaryConditionEnum {   doNothingCorner =-1, extrapolateCorner =0, symmetryCorner, taylor2ndOrder,   evenSymmetryCorner, oddSymmetryCorner, taylor2ndOrderEvenCorner, taylor4thOrderEvenCorner,   vectorSymmetryAxis1Corner, vectorSymmetryAxis2Corner, vectorSymmetryAxis3Corner }
enum	BoundaryConditionForcingOption {   unSpecifiedForcing =-1, scalarForcing =0, vectorForcing, vectorByFaceForcing,   arrayForcing, gridFunctionForcing }
enum	ExtrapolationOptionEnum { polynomialExtrapolation =0, extrapolateWithLimiter }

Public Member Functions
	BoundaryConditionParameters ()
	~BoundaryConditionParameters ()
int	setUseMask (int trueOrFalse=TRUE)
int	getUseMask () const
int	assignAllPointsOnMixedBoundaries (bool trueOrFalse=true)
intArray &	mask ()
CornerBoundaryConditionEnum	getCornerBoundaryCondition (int side1, int side2, int side3=-1) const
int	setCornerBoundaryCondition (CornerBoundaryConditionEnum bc)
int	setCornerBoundaryCondition (CornerBoundaryConditionEnum bc, int side1, int side2, int side3=-1)
int	setVectorSymmetryCornerComponent (int component)
int	getVectorSymmetryCornerComponent () const
int	setVariableCoefficientsArray (realSerialArray *var=NULL)
realSerialArray *	getVariableCoefficientsArray () const
void	setVariableCoefficients (REAL_MAPPED_GRID_FUNCTION &var)
void	setVariableCoefficients (REAL_GRID_COLLECTION_FUNCTION &var)
REAL_MAPPED_GRID_FUNCTION *	getVariableCoefficients () const
REAL_MAPPED_GRID_FUNCTION *	getVariableCoefficients (const int &grid) const
void	setRefinementLevelToSolveFor (int level)
int	getRefinementLevelToSolveFor () const
int	setBoundaryConditionForcingOption (BoundaryConditionForcingOption option)
BoundaryConditionForcingOption	getBoundaryConditionForcingOption () const
int	getCornerBC (int side1, int side2, int side3) const

Public Attributes
enum BoundaryConditionParameters::ExtrapolationOptionEnum	extrapolationOption
real	extrapolateWithLimiterParameters [2]
int	lineToAssign
int	orderOfExtrapolation
int	orderOfInterpolation
int	ghostLineToAssign
int	useMixedBoundaryMask
int	extraInTangentialDirections
int	numberOfCornerGhostLinesToAssign
int	cornerExtrapolationOption
IntegerArray	components
IntegerArray	uComponents
IntegerArray	fComponents
RealArray	a
RealArray	b0
RealArray	b1
RealArray	b2
RealArray	b3
int	interpolateRefinementBoundaries
int	interpolateHidden

Protected Attributes
CornerBoundaryConditionEnum	cornerBC [3][3][3]
int	vectorSymmetryCornerComponent
realSerialArray *	variableCoefficientsArray
REAL_MAPPED_GRID_FUNCTION *	variableCoefficients
REAL_GRID_COLLECTION_FUNCTION *	variableCoefficientsGC
int	useMask
intArray *	maskPointer
int	refinementLevelToSolveFor
BoundaryConditionForcingOption	boundaryConditionForcingOption

Member Enumeration Documentation

enum BoundaryConditionParameters::BoundaryConditionForcingOption

Enumerator
unSpecifiedForcing
scalarForcing
vectorForcing
vectorByFaceForcing
arrayForcing
gridFunctionForcing

enum BoundaryConditionParameters::CornerBoundaryConditionEnum

Enumerator
doNothingCorner
extrapolateCorner
symmetryCorner
taylor2ndOrder
evenSymmetryCorner
oddSymmetryCorner
taylor2ndOrderEvenCorner
taylor4thOrderEvenCorner
vectorSymmetryAxis1Corner
vectorSymmetryAxis2Corner
vectorSymmetryAxis3Corner

enum BoundaryConditionParameters::ExtrapolationOptionEnum

Enumerator
polynomialExtrapolation
extrapolateWithLimiter

Constructor & Destructor Documentation

BoundaryConditionParameters::BoundaryConditionParameters

(

)

References boundaryConditionForcingOption, cornerBC, cornerExtrapolationOption, extraInTangentialDirections, extrapolateCorner, extrapolateWithLimiterParameters, extrapolationOption, ghostLineToAssign, interpolateHidden, interpolateRefinementBoundaries, lineToAssign, maskPointer, numberOfCornerGhostLinesToAssign, orderOfExtrapolation, orderOfInterpolation, polynomialExtrapolation, refinementLevelToSolveFor, unSpecifiedForcing, useMask, useMixedBoundaryMask, variableCoefficients, variableCoefficientsArray, variableCoefficientsGC, and vectorSymmetryCornerComponent.

BoundaryConditionParameters::~BoundaryConditionParameters

(

)

References maskPointer, NULL, variableCoefficients, variableCoefficientsArray, and variableCoefficientsGC.

Member Function Documentation

int BoundaryConditionParameters::assignAllPointsOnMixedBoundaries

(

bool

trueOrFalse = true

)

References useMixedBoundaryMask.

BoundaryConditionParameters::BoundaryConditionForcingOption BoundaryConditionParameters::getBoundaryConditionForcingOption

(

)

const

References boundaryConditionForcingOption.

Referenced by MappedGridOperators::applyBoundaryCondition().

int BoundaryConditionParameters::getCornerBC ( int  side1, int  side2, int  side3  ) const

inline

References cornerBC.

Referenced by Ogmg::buildCoefficientArrays(), and GenericMappedGridOperators::fixBoundaryCorners().

BoundaryConditionParameters::CornerBoundaryConditionEnum BoundaryConditionParameters::getCornerBoundaryCondition	(	int	side1,
		int	side2,
		int	side3 = -1
	)		const

References Overture::abort().

Referenced by GenericMappedGridOperators::finishBoundaryConditions(), and GenericMappedGridOperators::setCornerCoefficients().

int BoundaryConditionParameters::getRefinementLevelToSolveFor ( ) const

inline

References refinementLevelToSolveFor.

Referenced by interpolateRefinements().

int BoundaryConditionParameters::getUseMask ( ) const

inline

References useMask.

Referenced by MappedGridOperators::applyBCaDotGradU(), MappedGridOperators::applyBCdirichlet(), MappedGridOperators::applyBCextrapolate(), MappedGridOperators::applyBCGenDiv(), MappedGridOperators::applyBCneumann(), MappedGridOperators::applyBCnormalComponent(), MappedGridOperators::applyBCnormalDerivative(), MappedGridOperators::applyBCtangentialComponent(), MappedGridOperators::applyBoundaryCondition(), and MappedGridOperators::applyBoundaryConditionCoefficients().

RealMappedGridFunction * BoundaryConditionParameters::getVariableCoefficients

(

)

const

References Overture::abort(), variableCoefficients, and variableCoefficientsGC.

Referenced by MappedGridOperators::applyBCnormalDotScalarGrad(), and MappedGridOperators::applyBoundaryConditionCoefficients().

RealMappedGridFunction * BoundaryConditionParameters::getVariableCoefficients

(

const int &

grid

)

const

References Overture::abort().

realSerialArray * BoundaryConditionParameters::getVariableCoefficientsArray

(

)

const

References variableCoefficientsArray.

int BoundaryConditionParameters::getVectorSymmetryCornerComponent

(

)

const

References vectorSymmetryCornerComponent.

Referenced by GenericMappedGridOperators::fixBoundaryCorners().

intArray & BoundaryConditionParameters::mask

(

)

References maskPointer.

int BoundaryConditionParameters::setBoundaryConditionForcingOption

(

BoundaryConditionForcingOption

option

)

References boundaryConditionForcingOption.

int BoundaryConditionParameters::setCornerBoundaryCondition

(

CornerBoundaryConditionEnum

bc

)

References cornerBC.

Referenced by Ogmg::applyBoundaryConditions(), Ogmg::buildCoefficientArrays(), and Ogmg::setCornerBoundaryConditions().

int BoundaryConditionParameters::setCornerBoundaryCondition	(	CornerBoundaryConditionEnum	bc,
		int	side1,
		int	side2,
		int	side3 = -1
	)

References Overture::abort(), and cornerBC.

void BoundaryConditionParameters::setRefinementLevelToSolveFor

(

int

level

)

References refinementLevelToSolveFor.

int BoundaryConditionParameters::setUseMask

(

int

trueOrFalse = TRUE

)

References useMask.

void BoundaryConditionParameters::setVariableCoefficients

(

REAL_MAPPED_GRID_FUNCTION &

var

)

void BoundaryConditionParameters::setVariableCoefficients

(

REAL_GRID_COLLECTION_FUNCTION &

var

)

int BoundaryConditionParameters::setVariableCoefficientsArray

(

realSerialArray *

var = NULL

)

References NULL, and variableCoefficientsArray.

int BoundaryConditionParameters::setVectorSymmetryCornerComponent

(

int

component

)

References vectorSymmetryCornerComponent.

Member Data Documentation

RealArray BoundaryConditionParameters::a

Referenced by MappedGridOperators::applyBCaDotGradU(), MappedGridOperators::applyBCaDotU(), MappedGridOperators::applyBCGenDiv(), MappedGridOperators::applyBCgeneralMixedDerivative(), MappedGridOperators::applyBCneumann(), MappedGridOperators::applyBoundaryConditionCoefficients(), Ogmg::applyBoundaryConditions(), Ogmg::assignBoundaryConditionCoefficients(), Ogmg::coarseGridSolverTest(), main(), Ogmg::operatorAveraging(), and Oges::setEquationAndBoundaryConditions().

RealArray BoundaryConditionParameters::b0

RealArray BoundaryConditionParameters::b1

RealArray BoundaryConditionParameters::b2

RealArray BoundaryConditionParameters::b3

BoundaryConditionForcingOption BoundaryConditionParameters::boundaryConditionForcingOption

protected

Referenced by BoundaryConditionParameters(), getBoundaryConditionForcingOption(), and setBoundaryConditionForcingOption().

IntegerArray BoundaryConditionParameters::components

CornerBoundaryConditionEnum BoundaryConditionParameters::cornerBC[3][3][3]

protected

Referenced by BoundaryConditionParameters(), getCornerBC(), and setCornerBoundaryCondition().

int BoundaryConditionParameters::cornerExtrapolationOption

Referenced by BoundaryConditionParameters(), and GenericMappedGridOperators::fixBoundaryCorners().

int BoundaryConditionParameters::extraInTangentialDirections

Referenced by MappedGridOperators::applyBCaDotGradU(), MappedGridOperators::applyBCaDotU(), MappedGridOperators::applyBCdirichlet(), MappedGridOperators::applyBCextrapolate(), MappedGridOperators::applyBCGenDiv(), MappedGridOperators::applyBCgeneralMixedDerivative(), MappedGridOperators::applyBCneumann(), MappedGridOperators::applyBCnormalComponent(), MappedGridOperators::applyBCnormalDerivative(), MappedGridOperators::applyBCnormalDotScalarGrad(), MappedGridOperators::applyBCsymmetry(), MappedGridOperators::applyBCtangentialComponent(), MappedGridOperators::applyBoundaryCondition(), MappedGridOperators::applyBoundaryConditionCoefficients(), and BoundaryConditionParameters().

real BoundaryConditionParameters::extrapolateWithLimiterParameters[2]

Referenced by MappedGridOperators::applyBCextrapolate(), MappedGridOperators::applyBoundaryCondition(), AssignInterpNeighbours::assign(), and BoundaryConditionParameters().

enum BoundaryConditionParameters::ExtrapolationOptionEnum BoundaryConditionParameters::extrapolationOption

Referenced by MappedGridOperators::applyBCextrapolate(), MappedGridOperators::applyBoundaryCondition(), AssignInterpNeighbours::assign(), and BoundaryConditionParameters().

IntegerArray BoundaryConditionParameters::fComponents

Referenced by MappedGridOperators::applyBoundaryCondition(), and MappedGridOperators::getVelocityComponents().

int BoundaryConditionParameters::ghostLineToAssign

Referenced by MappedGridOperators::applyBCextrapolate(), MappedGridOperators::applyBCsymmetry(), MappedGridOperators::applyBoundaryCondition(), MappedGridOperators::applyBoundaryConditionCoefficients(), Ogmg::assignBoundaryConditionCoefficients(), BoundaryConditionParameters(), Ogmg::buildCoefficientArrays(), Integrate::computeLeftNullVector(), Integrate::computeWeights(), main(), Ogmg::operatorAveraging(), Oges::setEquationAndBoundaryConditions(), and showFileFromDataFile().

int BoundaryConditionParameters::interpolateHidden

Referenced by BoundaryConditionParameters(), and interpolateRefinements().

int BoundaryConditionParameters::interpolateRefinementBoundaries

Referenced by BoundaryConditionParameters(), and interpolateRefinements().

int BoundaryConditionParameters::lineToAssign

Referenced by MappedGridOperators::applyBCaDotGradU(), MappedGridOperators::applyBCaDotU(), MappedGridOperators::applyBCdirichlet(), MappedGridOperators::applyBCextrapolate(), MappedGridOperators::applyBCGenDiv(), MappedGridOperators::applyBCgeneralMixedDerivative(), MappedGridOperators::applyBCneumann(), MappedGridOperators::applyBCnormalComponent(), MappedGridOperators::applyBCnormalDerivative(), MappedGridOperators::applyBCnormalDotScalarGrad(), MappedGridOperators::applyBCsymmetry(), MappedGridOperators::applyBCtangentialComponent(), MappedGridOperators::applyBoundaryCondition(), MappedGridOperators::applyBoundaryConditionCoefficients(), Ogmg::applyBoundaryConditions(), BoundaryConditionParameters(), and GenericMappedGridOperators::fixBoundaryCorners().

intArray* BoundaryConditionParameters::maskPointer

protected

Referenced by BoundaryConditionParameters(), mask(), and ~BoundaryConditionParameters().

int BoundaryConditionParameters::numberOfCornerGhostLinesToAssign

Referenced by Ogmg::applyBoundaryConditions(), BoundaryConditionParameters(), GenericMappedGridOperators::fixBoundaryCorners(), and Ogmg::setCornerBoundaryConditions().

int BoundaryConditionParameters::orderOfExtrapolation

Referenced by MappedGridOperators::applyBCextrapolate(), MappedGridOperators::applyBoundaryCondition(), MappedGridOperators::applyBoundaryConditionCoefficients(), EllipticGridGenerator::applyBoundaryConditions(), Ogmg::applyBoundaryConditions(), AssignInterpNeighbours::assign(), Ogmg::assignBoundaryConditionCoefficients(), BoundaryConditionParameters(), Ogmg::buildCoefficientArrays(), Integrate::computeLeftNullVector(), Integrate::computeWeights(), GenericMappedGridOperators::finishBoundaryConditions(), GenericMappedGridOperators::finishBoundaryConditionsOld(), GenericMappedGridOperators::fixBoundaryCorners(), ErrorEstimator::interpolateAndApplyBoundaryConditions(), main(), Ogmg::operatorAveraging(), Ogmg::setCornerBoundaryConditions(), GenericMappedGridOperators::setCornerCoefficients(), Oges::setEquationAndBoundaryConditions(), and showFileFromDataFile().

int BoundaryConditionParameters::orderOfInterpolation

Referenced by BoundaryConditionParameters().

int BoundaryConditionParameters::refinementLevelToSolveFor

protected

Referenced by BoundaryConditionParameters(), getRefinementLevelToSolveFor(), and setRefinementLevelToSolveFor().

IntegerArray BoundaryConditionParameters::uComponents

Referenced by MappedGridOperators::applyBoundaryCondition(), and MappedGridOperators::getVelocityComponents().

int BoundaryConditionParameters::useMask

protected

Referenced by BoundaryConditionParameters(), getUseMask(), and setUseMask().

int BoundaryConditionParameters::useMixedBoundaryMask

Referenced by MappedGridOperators::applyBCaDotGradU(), MappedGridOperators::applyBCdirichlet(), MappedGridOperators::applyBCextrapolate(), MappedGridOperators::applyBCGenDiv(), MappedGridOperators::applyBCneumann(), MappedGridOperators::applyBCnormalComponent(), MappedGridOperators::applyBCnormalDerivative(), MappedGridOperators::applyBCtangentialComponent(), MappedGridOperators::applyBoundaryCondition(), MappedGridOperators::applyBoundaryConditionCoefficients(), assignAllPointsOnMixedBoundaries(), and BoundaryConditionParameters().

REAL_MAPPED_GRID_FUNCTION* BoundaryConditionParameters::variableCoefficients

protected

Referenced by BoundaryConditionParameters(), getVariableCoefficients(), and ~BoundaryConditionParameters().

realSerialArray* BoundaryConditionParameters::variableCoefficientsArray

protected

Referenced by BoundaryConditionParameters(), getVariableCoefficientsArray(), setVariableCoefficientsArray(), and ~BoundaryConditionParameters().

REAL_GRID_COLLECTION_FUNCTION* BoundaryConditionParameters::variableCoefficientsGC

protected

Referenced by BoundaryConditionParameters(), getVariableCoefficients(), and ~BoundaryConditionParameters().

int BoundaryConditionParameters::vectorSymmetryCornerComponent

protected

Referenced by BoundaryConditionParameters(), getVectorSymmetryCornerComponent(), and setVectorSymmetryCornerComponent().

---

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

• BoundaryConditionParameters.h
• BoundaryConditionParameters.C