Public Member Functions | List of all members
externalCoupledMixedFvPatchField< Type > Class Template Reference
Boundary conditions » GenericBoundary conditions » | Coupled

Extends the mixed boundary condition with serialisation functions. More...

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

Public Member Functions

 TypeName ("externalCoupled")
 
 externalCoupledMixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 externalCoupledMixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 externalCoupledMixedFvPatchField (const externalCoupledMixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 externalCoupledMixedFvPatchField (const externalCoupledMixedFvPatchField &)
 
virtual tmp< fvPatchField< Type > > clone () const
 
 externalCoupledMixedFvPatchField (const externalCoupledMixedFvPatchField &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 
virtual ~externalCoupledMixedFvPatchField ()=default
 
virtual void writeHeader (Ostream &os) const
 
virtual void writeData (Ostream &os) const
 
virtual void readData (Istream &is)
 
- Public Member Functions inherited from mixedFvPatchField< Type >
 TypeName ("mixed")
 
 mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 mixedFvPatchField (const mixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 mixedFvPatchField (const mixedFvPatchField< Type > &)
 
 mixedFvPatchField (const mixedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual bool fixesValue () const
 
virtual bool assignable () const
 
virtual Field< Type > & refValue ()
 
virtual const Field< Type > & refValue () const
 
virtual Field< Type > & refGrad ()
 
virtual const Field< Type > & refGrad () const
 
virtual scalarField & valueFraction ()
 
virtual const scalarField & valueFraction () const
 
virtual Field< Type > & source ()
 
virtual const Field< Type > & source () const
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 
virtual tmp< Field< Type > > snGrad () const
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 
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 write (Ostream &) const
 
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 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 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)
 
void check (const fvPatchField< Type > &) const
 
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::externalCoupledMixedFvPatchField< Type >

Extends the mixed boundary condition with serialisation functions.

The serialisation functions:

It is used for coupling to external applications in combination with the externalCoupled functionObject. The default output is one line per face, with columns 

    <value> <snGrad> <refValue> <refGrad> <valueFraction>
Note
readData, writeData are not callbacks for regIOobject (since fvPatchField not derived from it). They do however do exactly the same - streaming of data.
See also
mixedFvPatchField externalCoupledFunctionObject
Source files

Definition at line 72 of file externalCoupledMixedFvPatchField.H.

Constructor & Destructor Documentation

◆ externalCoupledMixedFvPatchField() [1/5]

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

Definition at line 30 of file externalCoupledMixedFvPatchField.C.

◆ externalCoupledMixedFvPatchField() [2/5]

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

Definition at line 60 of file externalCoupledMixedFvPatchField.C.

◆ externalCoupledMixedFvPatchField() [3/5]

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

◆ externalCoupledMixedFvPatchField() [4/5]

externalCoupledMixedFvPatchField ( const externalCoupledMixedFvPatchField< Type > &  ecmpf)

Definition at line 73 of file externalCoupledMixedFvPatchField.C.

◆ externalCoupledMixedFvPatchField() [5/5]

externalCoupledMixedFvPatchField ( const externalCoupledMixedFvPatchField< Type > &  ecmpf,
const DimensionedField< Type, volMesh > &  iF 
)

Definition at line 84 of file externalCoupledMixedFvPatchField.C.

◆ ~externalCoupledMixedFvPatchField()

virtual ~externalCoupledMixedFvPatchField ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "externalCoupled"  )

◆ clone() [1/2]

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

Reimplemented from mixedFvPatchField< Type >.

Definition at line 117 of file externalCoupledMixedFvPatchField.H.

◆ clone() [2/2]

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

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in externalCoupledTemperatureMixedFvPatchScalarField.

Definition at line 134 of file externalCoupledMixedFvPatchField.H.

◆ writeHeader()

void writeHeader ( Ostream &  os) const
virtual

Reimplemented in externalCoupledTemperatureMixedFvPatchScalarField.

Definition at line 97 of file externalCoupledMixedFvPatchField.C.

◆ writeData()

void writeData ( Ostream &  os) const
virtual

Reimplemented in externalCoupledTemperatureMixedFvPatchScalarField.

Definition at line 107 of file externalCoupledMixedFvPatchField.C.

◆ readData()

void readData ( Istream &  is)
virtual

Reimplemented in externalCoupledTemperatureMixedFvPatchScalarField.

Definition at line 128 of file externalCoupledMixedFvPatchField.C.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17