Public Member Functions
wedgeFvPatchField< Type > Class Template Reference

This boundary condition is similar to the cyclic condition, except that it is applied to 2-D geometries. More...

Inheritance diagram for wedgeFvPatchField< Type >:
Inheritance graph
[legend]
Collaboration diagram for wedgeFvPatchField< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName (wedgeFvPatch::typeName_())
 Runtime type information. More...
 
 wedgeFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 wedgeFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 wedgeFvPatchField (const wedgeFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given wedgeFvPatchField onto a new patch. More...
 
 wedgeFvPatchField (const wedgeFvPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 wedgeFvPatchField (const wedgeFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &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::blocking)
 Evaluate the patch field. More...
 
virtual tmp< Field< Type > > snGradTransformDiag () const
 Return face-gradient transform diagonal. More...
 
tmp< scalarFieldsnGrad () const
 Return gradient at boundary. More...
 
void evaluate (const Pstream::commsTypes commsType)
 Evaluate the patch field, sets Updated to false. More...
 
tmp< scalarFieldsnGrad () const
 Return gradient at boundary. More...
 
void evaluate (const Pstream::commsTypes)
 Evaluate the patch field, sets Updated to false. More...
 
- Public Member Functions inherited from transformFvPatchField< Type >
 TypeName ("transform")
 Runtime type information. More...
 
 transformFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 transformFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 transformFvPatchField (const transformFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given transformFvPatchField<Type> More...
 
 transformFvPatchField (const transformFvPatchField< Type > &)
 Construct as copy. More...
 
 transformFvPatchField (const transformFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 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 fvPatchField< Type > &)
 
tmp< scalarFieldvalueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
tmp< scalarFieldgradientInternalCoeffs () const
 
Foam::tmp< Foam::scalarFieldvalueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
Foam::tmp< Foam::scalarFieldgradientInternalCoeffs () const
 
- Public Member Functions inherited from fvPatchField< Type >
 TypeName ("fvPatchField")
 Runtime type information. More...
 
 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 > &)
 Construct from patch and internal field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
 Construct from patch and internal field and patch type. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
 Construct from patch, internal field and dictionary. More...
 
 fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvPatchField onto a new patch. More...
 
 fvPatchField (const fvPatchField< Type > &)
 Construct as copy. More...
 
 fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone. More...
 
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatch &p)
 
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &pf)
 
virtual ~fvPatchField ()
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const fvPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, volMesh > & dimensionedInternalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & internalField () const
 Return internal field reference. More...
 
const wordpatchType () const
 Optional patch type. More...
 
wordpatchType ()
 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...
 
bool manipulatedMatrix () const
 Return true if the matrix has already been manipulated. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual tmp< Field< Type > > snGrad () const
 Return patch-normal gradient. More...
 
virtual tmp< Field< Type > > snGrad (const scalarField &deltaCoeffs) const
 Return patch-normal gradient for coupled-patches. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void updateCoeffs (const scalarField &weights)
 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 void patchInternalField (Field< Type > &) 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::blocking)
 Initialise the evaluation of the patch field. More...
 
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientInternalCoeffs (const scalarField &deltaCoeffs) 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 tmp< Field< Type > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix)
 Manipulate matrix. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
 Manipulate matrix with given weights. More...
 
virtual void write (Ostream &) const
 Write. More...
 
void writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
 Helper function to write the keyword and entry only if the. More...
 
void check (const fvPatchField< Type > &) const
 Check fvPatchField<Type> against given fvPatchField<Type> More...
 
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
 
- Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > > New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< Type > > New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< Type > > New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static tmp< fvPatchField< Type > > New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatch &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
static const wordcalculatedType ()
 Return the type of the calculated for of fvPatchField. More...
 
- Static Public Attributes inherited from fvPatchField< Type >
static int disallowGenericFvPatchField
 Debug switch to disallow the use of genericFvPatchField. More...
 

Detailed Description

template<class Type>
class Foam::wedgeFvPatchField< Type >

This boundary condition is similar to the cyclic condition, except that it is applied to 2-D geometries.


Patch usage

Example of the boundary condition specification:

myPatch
{
    type            wedge;
}
See also
Foam::cyclicFvPatchField
Source files

Definition at line 67 of file wedgeFvPatchField.H.

Constructor & Destructor Documentation

◆ wedgeFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 37 of file wedgeFvPatchField.C.

◆ wedgeFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 71 of file wedgeFvPatchField.C.

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

Here is the call graph for this function:

◆ wedgeFvPatchField() [3/5]

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

Construct by mapping given wedgeFvPatchField onto a new patch.

Definition at line 48 of file wedgeFvPatchField.C.

References dimensionedInternalField(), Foam::exit(), FatalErrorInFunction, Foam::FatalIOError, and p.

Here is the call graph for this function:

◆ wedgeFvPatchField() [4/5]

wedgeFvPatchField ( const wedgeFvPatchField< Type > &  ptf)

Construct as copy.

Definition at line 98 of file wedgeFvPatchField.C.

◆ wedgeFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 108 of file wedgeFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( wedgeFvPatch::typeName_()  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Implements transformFvPatchField< Type >.

Definition at line 111 of file wedgeFvPatchField.H.

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Implements transformFvPatchField< Type >.

Definition at line 128 of file wedgeFvPatchField.H.

◆ snGrad() [1/3]

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

Return gradient at boundary.

Implements transformFvPatchField< Type >.

Definition at line 120 of file wedgeFvPatchField.C.

References Foam::transform().

Here is the call graph for this function:

◆ evaluate() [1/3]

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

Evaluate the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 132 of file wedgeFvPatchField.C.

References Foam::transform().

Here is the call graph for this function:

◆ snGradTransformDiag()

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

Return face-gradient transform diagonal.

Implements transformFvPatchField< Type >.

Definition at line 152 of file wedgeFvPatchField.C.

References Foam::diag(), Foam::I, Foam::pow(), Foam::type(), DiagTensor< Cmpt >::xx(), DiagTensor< Cmpt >::yy(), and DiagTensor< Cmpt >::zz().

Here is the call graph for this function:

◆ snGrad() [2/3]

tmp< scalarField > snGrad ( ) const
virtual

Return gradient at boundary.

Implements transformFvPatchField< Type >.

◆ evaluate() [2/3]

void evaluate ( const Pstream::commsTypes  commsType)
virtual

Evaluate the patch field, sets Updated to false.

Reimplemented from fvPatchField< Type >.

◆ snGrad() [3/3]

tmp< scalarField > snGrad ( ) const
virtual

Return gradient at boundary.

Implements transformFvPatchField< Type >.

Definition at line 37 of file wedgeFvPatchScalarField.C.

◆ evaluate() [3/3]

void evaluate ( const Pstream::commsTypes  commsType)
virtual

Evaluate the patch field, sets Updated to false.

Reimplemented from fvPatchField< Type >.

Definition at line 44 of file wedgeFvPatchScalarField.C.

References Foam::operator==().

Here is the call graph for this function:

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