Public Member Functions | Private Attributes
mixedFixedValueSlipFvPatchField< Type > Class Template Reference

A mixed boundary type that blends between fixedValue and slip, as opposed to the standard mixed condition that blends between fixedValue and fixedGradient; required to implement maxwellSlipU condition. More...

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

Public Member Functions

 TypeName ("mixedFixedValueSlip")
 Runtime type information. More...
 
 mixedFixedValueSlipFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 mixedFixedValueSlipFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 mixedFixedValueSlipFvPatchField (const mixedFixedValueSlipFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 mixedFixedValueSlipFvPatchField (const mixedFixedValueSlipFvPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 mixedFixedValueSlipFvPatchField (const mixedFixedValueSlipFvPatchField< 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 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 Field< Type > & refValue ()
 
virtual const Field< Type > & refValue () const
 
virtual scalarFieldvalueFraction ()
 
virtual const scalarFieldvalueFraction () const
 
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...
 
virtual void write (Ostream &) const
 Write. More...
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const fvPatchField< Type > &)
 
virtual void operator+= (const fvPatchField< Type > &)
 
virtual void operator-= (const fvPatchField< Type > &)
 
virtual void operator*= (const fvPatchField< scalar > &)
 
virtual void operator/= (const fvPatchField< 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)
 
- 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...
 
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 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...
 
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 fvPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 

Private Attributes

Field< Type > refValue_
 Value field used for boundary condition. More...
 
scalarField valueFraction_
 Fraction (0-1) of value used for boundary condition. More...
 

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::mixedFixedValueSlipFvPatchField< Type >

A mixed boundary type that blends between fixedValue and slip, as opposed to the standard mixed condition that blends between fixedValue and fixedGradient; required to implement maxwellSlipU condition.

Source files

Definition at line 51 of file mixedFixedValueSlipFvPatchField.H.

Constructor & Destructor Documentation

◆ mixedFixedValueSlipFvPatchField() [1/5]

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

Construct from patch and internal field.

◆ mixedFixedValueSlipFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

◆ mixedFixedValueSlipFvPatchField() [3/5]

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

Construct by mapping given mixedFixedValueSlipFvPatchField Onto a new patch

◆ mixedFixedValueSlipFvPatchField() [4/5]

Construct as copy.

◆ mixedFixedValueSlipFvPatchField() [5/5]

Construct as copy setting internal field reference.

Member Function Documentation

◆ TypeName()

TypeName ( "mixedFixedValueSlip"  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Implements transformFvPatchField< Type >.

Definition at line 103 of file mixedFixedValueSlipFvPatchField.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 120 of file mixedFixedValueSlipFvPatchField.H.

◆ autoMap()

virtual void autoMap ( const fvPatchFieldMapper )
virtual

Map (and resize as needed) from self given a mapping object.

Reimplemented from fvPatchField< Type >.

◆ rmap()

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

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from fvPatchField< Type >.

◆ refValue() [1/2]

virtual Field<Type>& refValue ( )
inlinevirtual

◆ refValue() [2/2]

virtual const Field<Type>& refValue ( ) const
inlinevirtual

◆ valueFraction() [1/2]

virtual scalarField& valueFraction ( )
inlinevirtual

◆ valueFraction() [2/2]

virtual const scalarField& valueFraction ( ) const
inlinevirtual

◆ snGrad()

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

Return gradient at boundary.

Implements transformFvPatchField< Type >.

◆ evaluate()

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

Evaluate the patch field.

Reimplemented from fvPatchField< Type >.

◆ snGradTransformDiag()

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

Return face-gradient transform diagonal.

Implements transformFvPatchField< Type >.

◆ write()

virtual void write ( Ostream ) const
virtual

Write.

Reimplemented from fvPatchField< Type >.

◆ operator=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 190 of file mixedFixedValueSlipFvPatchField.H.

◆ operator=() [2/3]

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

Reimplemented from transformFvPatchField< Type >.

Definition at line 192 of file mixedFixedValueSlipFvPatchField.H.

◆ operator+=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 193 of file mixedFixedValueSlipFvPatchField.H.

◆ operator-=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 194 of file mixedFixedValueSlipFvPatchField.H.

◆ operator*=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 195 of file mixedFixedValueSlipFvPatchField.H.

◆ operator/=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 196 of file mixedFixedValueSlipFvPatchField.H.

◆ operator+=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 198 of file mixedFixedValueSlipFvPatchField.H.

◆ operator-=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 199 of file mixedFixedValueSlipFvPatchField.H.

◆ operator*=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 201 of file mixedFixedValueSlipFvPatchField.H.

◆ operator/=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 202 of file mixedFixedValueSlipFvPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 204 of file mixedFixedValueSlipFvPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 205 of file mixedFixedValueSlipFvPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 206 of file mixedFixedValueSlipFvPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const  scalar)
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 207 of file mixedFixedValueSlipFvPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const  scalar)
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 208 of file mixedFixedValueSlipFvPatchField.H.

Field Documentation

◆ refValue_

Field<Type> refValue_
private

Value field used for boundary condition.

Definition at line 58 of file mixedFixedValueSlipFvPatchField.H.

Referenced by mixedFixedValueSlipFvPatchField< Type >::refValue().

◆ valueFraction_

scalarField valueFraction_
private

Fraction (0-1) of value used for boundary condition.

Definition at line 61 of file mixedFixedValueSlipFvPatchField.H.

Referenced by mixedFixedValueSlipFvPatchField< Type >::valueFraction().


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