velocityFilmShellFvPatchVectorField Class Reference
Inheritance diagram for velocityFilmShellFvPatchVectorField:
[legend]
Collaboration diagram for velocityFilmShellFvPatchVectorField:
[legend]

Public Member Functions

 TypeName ("velocityFilmShell")
 Runtime type information. More...
 
 velocityFilmShellFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 velocityFilmShellFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 velocityFilmShellFvPatchVectorField (const velocityFilmShellFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 
virtual tmp< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 velocityFilmShellFvPatchVectorField (const velocityFilmShellFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from mixedFvPatchField< vector >
 TypeName ("mixed")
 Runtime type information. More...
 
 mixedFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 mixedFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 mixedFvPatchField (const mixedFvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given mixedFvPatchField onto a new patch. More...
 
 mixedFvPatchField (const mixedFvPatchField< vector > &)
 Construct as copy. More...
 
 mixedFvPatchField (const mixedFvPatchField< vector > &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
virtual bool assignable () const
 Return false: this patch field is not altered by assignment. More...
 
virtual Field< vector > & refValue ()
 
virtual const Field< vector > & refValue () const
 
virtual Field< vector > & refGrad ()
 
virtual const Field< vector > & refGrad () const
 
virtual scalarFieldvalueFraction ()
 
virtual const scalarFieldvalueFraction () const
 
virtual Field< vector > & source ()
 
virtual const Field< vector > & source () const
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchField< vector > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual tmp< Field< vector > > 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< vector > > valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the. More...
 
virtual void operator= (const UList< vector > &)
 
virtual void operator= (const fvPatchField< vector > &)
 
virtual void operator= (const vector &)
 
virtual void operator+= (const fvPatchField< vector > &)
 
virtual void operator+= (const Field< vector > &)
 
virtual void operator+= (const vector &)
 
virtual void operator-= (const fvPatchField< vector > &)
 
virtual void operator-= (const Field< vector > &)
 
virtual void operator-= (const vector &)
 
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)
 
- Public Member Functions inherited from fvPatchField< vector >
 TypeName ("fvPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< vector, volMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< vector > &ptf, const fvPatch &p, const DimensionedField< vector, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< vector, volMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 fvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const vector &value)
 Construct from patch, internal field and value. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const word &patchType)
 Construct from patch and internal field and patch type. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const Field< vector > &)
 Construct from patch and internal field and patch field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 fvPatchField (const fvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvPatchField onto a new patch. More...
 
 fvPatchField (const fvPatchField< vector > &)
 Construct as copy. More...
 
 fvPatchField (const fvPatchField< vector > &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
Foam::tmp< Foam::fvPatchField< vector > > NewCalculatedType (const fvPatchField< Type2 > &pf)
 
virtual ~fvPatchField ()=default
 Destructor. More...
 
bool useImplicit () const noexcept
 Use implicit formulation for coupled patches only. More...
 
bool useImplicit (bool on) noexcept
 Set useImplicit on/off. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const fvPatchpatch () const
 Return patch. More...
 
const DimensionedField< vector, volMesh > & internalField () const
 Return dimensioned internal field reference. More...
 
const Field< vector > & primitiveField () const
 Return internal field reference. More...
 
const wordpatchType () const
 Optional patch type. More...
 
wordpatchType ()
 Optional patch type. 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< vector > > snGrad (const scalarField &deltaCoeffs) const
 Return patch-normal gradient for coupled-patches. More...
 
virtual void updateWeightedCoeffs (const scalarField &weights)
 Update the coefficients associated with the patch field. More...
 
virtual tmp< Field< vector > > patchInternalField () const
 Return internal field next to patch as patch field. More...
 
virtual void patchInternalField (Field< vector > &) const
 Return internal field next to patch as patch field. More...
 
virtual tmp< Field< vector > > 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< vector > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual void manipulateMatrix (fvMatrix< vector > &matrix)
 Manipulate matrix. More...
 
virtual void manipulateMatrix (fvMatrix< vector > &matrix, const scalarField &weights)
 Manipulate matrix with given weights. More...
 
virtual void manipulateMatrix (fvMatrix< vector > &matrix, const label iMatrix, const direction cmp)
 Manipulate fvMatrix. More...
 
void check (const fvPatchField< vector > &) const
 Check fvPatchField<Type> against given fvPatchField<Type> More...
 
virtual void operator== (const fvPatchField< vector > &)
 
virtual void operator== (const Field< vector > &)
 
virtual void operator== (const vector &)
 

Additional Inherited Members

- Public Types inherited from fvPatchField< vector >
typedef fvPatch Patch
 
typedef calculatedFvPatchField< vectorCalculated
 
- Static Public Member Functions inherited from fvPatchField< vector >
static tmp< fvPatchField< vector > > New (const word &, const fvPatch &, const DimensionedField< vector, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< vector > > New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< vector, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< vector > > New (const fvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static tmp< fvPatchField< vector > > New (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
static tmp< fvPatchField< vector > > NewCalculatedType (const fvPatch &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
static tmp< fvPatchField< vector > > 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< vector >
static int disallowGenericFvPatchField
 Debug switch to disallow the use of genericFvPatchField. More...
 

Detailed Description

Definition at line 211 of file velocityFilmShellFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ velocityFilmShellFvPatchVectorField() [1/4]

Construct from patch and internal field.

Definition at line 39 of file velocityFilmShellFvPatchVectorField.C.

Referenced by velocityFilmShellFvPatchVectorField::clone().

Here is the caller graph for this function:

◆ velocityFilmShellFvPatchVectorField() [2/4]

velocityFilmShellFvPatchVectorField ( const fvPatch p,
const DimensionedField< vector, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 79 of file velocityFilmShellFvPatchVectorField.C.

References dict, dictionary::found(), Foam::New(), fvPatchField< vector >::operator=(), p, and VectorSpace< Vector< scalar >, scalar, 3 >::zero.

Here is the call graph for this function:

◆ velocityFilmShellFvPatchVectorField() [3/4]

Construct by mapping given velocityFilmShellFvPatchVectorField onto a new patch

Definition at line 57 of file velocityFilmShellFvPatchVectorField.C.

◆ velocityFilmShellFvPatchVectorField() [4/4]

Construct as copy setting internal field reference.

Definition at line 118 of file velocityFilmShellFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "velocityFilmShell"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from mixedFvPatchField< vector >.

Definition at line 264 of file velocityFilmShellFvPatchVectorField.H.

References velocityFilmShellFvPatchVectorField::velocityFilmShellFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchVectorField> clone ( const DimensionedField< vector, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from mixedFvPatchField< vector >.

Definition at line 281 of file velocityFilmShellFvPatchVectorField.H.

References velocityFilmShellFvPatchVectorField::velocityFilmShellFvPatchVectorField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from mixedFvPatchField< vector >.

Definition at line 172 of file velocityFilmShellFvPatchVectorField.C.

References os(), dictionary::remove(), mixedFvPatchField< Type >::write(), and dictionary::write().

Here is the call graph for this function:

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