This boundary condition enforces a symmetryPlane constraint. More...

Inheritance diagram for symmetryPlaneFvPatchField< Type >:

Collaboration diagram for symmetryPlaneFvPatchField< Type >:

Public Member Functions
	TypeName (symmetryPlaneFvPatch::typeName_())

	symmetryPlaneFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	symmetryPlaneFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

	symmetryPlaneFvPatchField (const symmetryPlaneFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	symmetryPlaneFvPatchField (const symmetryPlaneFvPatchField< Type > &)

virtual tmp< fvPatchField< Type > >	clone () const

	symmetryPlaneFvPatchField (const symmetryPlaneFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const

virtual tmp< Field< Type > >	snGrad () const

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

virtual tmp< Field< Type > >	snGradTransformDiag () const

tmp< scalarField >	snGrad () const

void	evaluate (const Pstream::commsTypes commsType)

Foam::tmp< Foam::scalarField >	snGrad () const

void	evaluate (const Pstream::commsTypes)

Public Member Functions inherited from basicSymmetryFvPatchField< Type >
	basicSymmetryFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	basicSymmetryFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

	basicSymmetryFvPatchField (const basicSymmetryFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	basicSymmetryFvPatchField (const basicSymmetryFvPatchField< Type > &)

	basicSymmetryFvPatchField (const basicSymmetryFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

Public Member Functions inherited from transformFvPatchField< Type >
	TypeName ("transform")

	transformFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	transformFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

	transformFvPatchField (const transformFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	transformFvPatchField (const transformFvPatchField< Type > &)

	transformFvPatchField (const transformFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual bool	assignable () const

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

virtual void	operator= (const fvPatchField< Type > &)

tmp< scalarField >	valueInternalCoeffs (const tmp< scalarField > &) const

tmp< scalarField >	gradientInternalCoeffs () const

Foam::tmp< Foam::scalarField >	valueInternalCoeffs (const tmp< scalarField > &) const

Foam::tmp< Foam::scalarField >	gradientInternalCoeffs () const

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	fvPatchField (const fvPatchField< Type > &)

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual tmp< fvPatchField< Type > >	clone () const

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

virtual	~fvPatchField ()=default

bool	useImplicit () const noexcept

bool	useImplicit (bool on) noexcept

virtual bool	fixesValue () const

virtual bool	assignable () const

virtual bool	coupled () const

const objectRegistry &	db () const

const fvPatch &	patch () const

const DimensionedField< Type, volMesh > &	internalField () const

const Field< Type > &	primitiveField () const

const word &	patchType () const

word &	patchType ()

bool	updated () const

bool	manipulatedMatrix () const

virtual void	autoMap (const fvPatchFieldMapper &)

virtual void	rmap (const fvPatchField< Type > &, const labelList &)

virtual tmp< Field< Type > >	snGrad () const

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const

virtual void	updateCoeffs ()

virtual void	updateWeightedCoeffs (const scalarField &weights)

virtual tmp< Field< Type > >	patchInternalField () const

virtual void	patchInternalField (Field< Type > &) const

virtual tmp< Field< Type > >	patchNeighbourField () const

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)

virtual void	write (Ostream &) const

void	check (const fvPatchField< Type > &) const

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const fvPatchField< scalar > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const fvPatchField< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator/= (const scalar)

virtual void	operator== (const fvPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

typedef calculatedFvPatchField< Type >	Calculated

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)

static const word &	calculatedType ()

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField

Detailed Description

template<class Type>
class Foam::symmetryPlaneFvPatchField< Type >

This boundary condition enforces a symmetryPlane constraint.

Usage

Example of the boundary condition specification:

<patchName>
{
    type            symmetryPlane;
}

Source files

Definition at line 63 of file symmetryPlaneFvPatchField.H.

Constructor & Destructor Documentation

◆ symmetryPlaneFvPatchField() [1/5]

symmetryPlaneFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 28 of file symmetryPlaneFvPatchField.C.

◆ symmetryPlaneFvPatchField() [2/5]

symmetryPlaneFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Definition at line 64 of file symmetryPlaneFvPatchField.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and p.

Here is the call graph for this function:

◆ symmetryPlaneFvPatchField() [3/5]

symmetryPlaneFvPatchField	(	const symmetryPlaneFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Definition at line 40 of file symmetryPlaneFvPatchField.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, p, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ symmetryPlaneFvPatchField() [4/5]

symmetryPlaneFvPatchField ( const symmetryPlaneFvPatchField< Type > & ptf )

Definition at line 88 of file symmetryPlaneFvPatchField.C.

◆ symmetryPlaneFvPatchField() [5/5]

symmetryPlaneFvPatchField	(	const symmetryPlaneFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 99 of file symmetryPlaneFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( symmetryPlaneFvPatch::typeName_() )

◆ clone() [1/2]

virtual tmp<fvPatchField<Type> > clone ( ) const

inlinevirtual

Reimplemented from basicSymmetryFvPatchField< Type >.

Definition at line 113 of file symmetryPlaneFvPatchField.H.

◆ clone() [2/2]

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > & iF ) const

inlinevirtual

Reimplemented from basicSymmetryFvPatchField< Type >.

Definition at line 130 of file symmetryPlaneFvPatchField.H.

◆ snGrad() [1/3]

Foam::tmp< Foam::Field< Type > > snGrad

virtual

Reimplemented from basicSymmetryFvPatchField< Type >.

Definition at line 113 of file symmetryPlaneFvPatchField.C.

References Foam::I, Foam::foamVersion::patch, Foam::sqr(), and Foam::transform().

Here is the call graph for this function:

◆ evaluate() [1/3]

void evaluate ( const Pstream::commsTypes commsType = Pstream::commsTypes::blocking )

virtual

Reimplemented from basicSymmetryFvPatchField< Type >.

Definition at line 126 of file symmetryPlaneFvPatchField.C.

References Foam::stringOps::evaluate(), Foam::I, Foam::sqr(), and Foam::transform().

Here is the call graph for this function:

◆ snGradTransformDiag()

Foam::tmp< Foam::Field< Type > > snGradTransformDiag

virtual

Reimplemented from basicSymmetryFvPatchField< Type >.

Definition at line 148 of file symmetryPlaneFvPatchField.C.

References VectorSpace::component(), Foam::diag(), Foam::mag(), Foam::pow(), and Y.

Here is the call graph for this function:

◆ snGrad() [2/3]

tmp< scalarField > snGrad ( ) const

virtual

Reimplemented from basicSymmetryFvPatchField< Type >.

◆ evaluate() [2/3]

void evaluate ( const Pstream::commsTypes commsType )

virtual

Reimplemented from basicSymmetryFvPatchField< Type >.

◆ snGrad() [3/3]

Foam::tmp< Foam::scalarField > snGrad ( ) const

virtual

Reimplemented from basicSymmetryFvPatchField< Type >.

Definition at line 28 of file symmetryPlaneFvPatchScalarField.C.

References Foam::New(), and Foam::Zero.

Here is the call graph for this function:

◆ evaluate() [3/3]

void evaluate ( const Pstream::commsTypes )

virtual

Reimplemented from basicSymmetryFvPatchField< Type >.

Definition at line 36 of file symmetryPlaneFvPatchScalarField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

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

src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.H
src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::symmetryPlaneFvPatchField< Type >

Constructor & Destructor Documentation

◆ symmetryPlaneFvPatchField() [1/5]

◆ symmetryPlaneFvPatchField() [2/5]

◆ symmetryPlaneFvPatchField() [3/5]

◆ symmetryPlaneFvPatchField() [4/5]

◆ symmetryPlaneFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ snGrad() [1/3]

◆ evaluate() [1/3]

◆ snGradTransformDiag()

◆ snGrad() [2/3]

◆ evaluate() [2/3]

◆ snGrad() [3/3]

◆ evaluate() [3/3]

template<class Type>
class Foam::symmetryPlaneFvPatchField< Type >