A symmetry patch. More...

Inheritance diagram for basicSymmetryFaPatchField< Type >:

Collaboration diagram for basicSymmetryFaPatchField< Type >:

Public Member Functions
	basicSymmetryFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	basicSymmetryFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	basicSymmetryFaPatchField (const basicSymmetryFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping given basicSymmetryFaPatchField onto a new patch. More...

	basicSymmetryFaPatchField (const basicSymmetryFaPatchField< Type > &)
	Construct as copy. More...

virtual tmp< faPatchField< Type > >	clone () const
	Construct and return a clone. More...

	basicSymmetryFaPatchField (const basicSymmetryFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< faPatchField< Type > >	clone (const DimensionedField< Type, areaMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual tmp< Field< Type > >	snGrad () const
	Return gradient at boundary. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field. More...

virtual tmp< Field< Type > >	snGradTransformDiag () const
	Return face-gradient transform diagonal. More...

template<>
tmp< scalarField >	snGrad () const
	Return gradient at boundary. More...

template<>
void	evaluate (const Pstream::commsTypes commsType)
	Evaluate the patch field, sets Updated to false. More...

template<>
Foam::tmp< Foam::scalarField >	snGrad () const
	Return gradient at boundary. More...

template<>
void	evaluate (const Pstream::commsTypes)
	Evaluate the patch field, sets Updated to false. More...

Public Member Functions inherited from transformFaPatchField< Type >
	TypeName ("transform")
	Runtime type information. More...

	transformFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	transformFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	transformFaPatchField (const transformFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping the given transformFaPatchField<Type> More...

	transformFaPatchField (const transformFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

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

template<>
tmp< scalarField >	gradientInternalCoeffs () const

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

Public Member Functions inherited from faPatchField< Type >
	TypeName ("faPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict))

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping the given faPatchField onto a new patch. More...

	faPatchField (const faPatchField< Type > &)
	Construct as copy. More...

	faPatchField (const faPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
	Construct as copy setting internal field reference. More...

virtual	~faPatchField ()=default
	Destructor. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const faPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, areaMesh > &	internalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	primitiveField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

virtual void	autoMap (const faPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const faPatchField< Type > &, const labelList &)
	Reverse map the given faPatchField onto this faPatchField. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Initialise the evaluation of the patch field. More...

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

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

virtual void	write (Ostream &) const
	Write. More...

void	check (const faPatchField< Type > &) const
	Check faPatchField<Type> against given faPatchField<Type> More...

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

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

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

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

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

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

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

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

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

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

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

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

virtual void	operator== (const Type &)

template<class Type2 >
Foam::tmp< Foam::faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &pf)

Additional Inherited Members
Public Types inherited from faPatchField< Type >
typedef faPatch	Patch

typedef calculatedFaPatchField< Type >	Calculated

Static Public Member Functions inherited from faPatchField< Type >
static tmp< faPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &)

static tmp< faPatchField< Type > >	New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)

static tmp< faPatchField< Type > >	New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)

static tmp< faPatchField< Type > >	New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)

template<class Type2 >
static tmp< faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &)

static const word &	calculatedType ()
	Return the type of the calculated for of faPatchField. More...

Static Public Attributes inherited from faPatchField< Type >
static int	disallowGenericFaPatchField
	Debug switch to disallow the use of. More...

Detailed Description

template<class Type>
class Foam::basicSymmetryFaPatchField< Type >

A symmetry patch.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 56 of file basicSymmetryFaPatchField.H.

Constructor & Destructor Documentation

◆ basicSymmetryFaPatchField() [1/5]

basicSymmetryFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 35 of file basicSymmetryFaPatchField.C.

◆ basicSymmetryFaPatchField() [2/5]

basicSymmetryFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 59 of file basicSymmetryFaPatchField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

◆ basicSymmetryFaPatchField() [3/5]

basicSymmetryFaPatchField	(	const basicSymmetryFaPatchField< Type > &	ptf,
		const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const faPatchFieldMapper &	mapper
	)

Construct by mapping given basicSymmetryFaPatchField onto a new patch.

Definition at line 46 of file basicSymmetryFaPatchField.C.

◆ basicSymmetryFaPatchField() [4/5]

basicSymmetryFaPatchField ( const basicSymmetryFaPatchField< Type > & ptf )

Construct as copy.

Definition at line 73 of file basicSymmetryFaPatchField.C.

◆ basicSymmetryFaPatchField() [5/5]

basicSymmetryFaPatchField	(	const basicSymmetryFaPatchField< Type > &	ptf,
		const DimensionedField< Type, areaMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 83 of file basicSymmetryFaPatchField.C.

Member Function Documentation

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Implements transformFaPatchField< Type >.

Reimplemented in symmetryFaPatchField< Type >, and slipFaPatchField< Type >.

Definition at line 96 of file basicSymmetryFaPatchField.H.

◆ clone() [2/2]

virtual tmp<faPatchField<Type> > clone ( const DimensionedField< Type, areaMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Implements transformFaPatchField< Type >.

Reimplemented in symmetryFaPatchField< Type >, and slipFaPatchField< Type >.

Definition at line 113 of file basicSymmetryFaPatchField.H.

◆ snGrad() [1/3]

Foam::tmp< Foam::Field< Type > > snGrad ( ) const

virtual

Return gradient at boundary.

Implements transformFaPatchField< Type >.

Definition at line 96 of file basicSymmetryFaPatchField.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

Evaluate the patch field.

Default argument needed to allow call in constructors HJ, 30/Jun/2009

Reimplemented from faPatchField< Type >.

Definition at line 109 of file basicSymmetryFaPatchField.C.

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

Here is the call graph for this function:

◆ snGradTransformDiag()

Foam::tmp< Foam::Field< Type > > snGradTransformDiag ( ) const

virtual

Return face-gradient transform diagonal.

Implements transformFaPatchField< Type >.

Definition at line 131 of file basicSymmetryFaPatchField.C.

References Field< Type >::component(), Foam::diag(), Foam::mag(), Foam::foamVersion::patch, Foam::pow(), and Y.

Here is the call graph for this function:

◆ snGrad() [2/3]

tmp< scalarField > snGrad ( ) const

virtual

Return gradient at boundary.

Implements transformFaPatchField< Type >.

◆ evaluate() [2/3]

void evaluate ( const Pstream::commsTypes commsType )

virtual

Evaluate the patch field, sets Updated to false.

Reimplemented from faPatchField< Type >.

◆ snGrad() [3/3]

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

virtual

Return gradient at boundary.

Implements transformFaPatchField< Type >.

Definition at line 35 of file basicSymmetryFaPatchScalarField.C.

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

Here is the call graph for this function:

◆ evaluate() [3/3]

void evaluate ( const Pstream::commsTypes commsType )

virtual

Evaluate the patch field, sets Updated to false.

Reimplemented from faPatchField< Type >.

Definition at line 43 of file basicSymmetryFaPatchScalarField.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/finiteArea/fields/faPatchFields/basic/basicSymmetry/basicSymmetryFaPatchField.H
src/finiteArea/fields/faPatchFields/basic/basicSymmetry/basicSymmetryFaPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::basicSymmetryFaPatchField< Type >

Constructor & Destructor Documentation

◆ basicSymmetryFaPatchField() [1/5]

◆ basicSymmetryFaPatchField() [2/5]

◆ basicSymmetryFaPatchField() [3/5]

◆ basicSymmetryFaPatchField() [4/5]

◆ basicSymmetryFaPatchField() [5/5]

Member Function Documentation

◆ 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::basicSymmetryFaPatchField< Type >