Public Member Functions | List of all members
timeVaryingMappedFixedValueFvPatchField< Type > Class Template Reference

This boundary conditions interpolates the values from a set of supplied points in space and time. More...

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

Public Member Functions

 TypeName ("timeVaryingMappedFixedValue")
 
 timeVaryingMappedFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 timeVaryingMappedFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 timeVaryingMappedFixedValueFvPatchField (const timeVaryingMappedFixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 timeVaryingMappedFixedValueFvPatchField (const timeVaryingMappedFixedValueFvPatchField< Type > &)
 
virtual tmp< fvPatchField< Type > > clone () const
 
 timeVaryingMappedFixedValueFvPatchField (const timeVaryingMappedFixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 
virtual void updateCoeffs ()
 
virtual void write (Ostream &) const
 
- Public Member Functions inherited from fixedValueFvPatchField< Type >
 TypeName ("fixedValue")
 
 fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
 
 fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
 
 fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 fixedValueFvPatchField (const fixedValueFvPatchField< Type > &)
 
 fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual bool fixesValue () const
 
virtual bool assignable () const
 
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 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 objectRegistrydb () const
 
const fvPatchpatch () const
 
const DimensionedField< Type, volMesh > & internalField () const
 
const Field< Type > & primitiveField () const
 
const wordpatchType () const
 
wordpatchType ()
 
bool updated () const
 
bool manipulatedMatrix () const
 
virtual tmp< Field< Type > > snGrad () const
 
virtual tmp< Field< Type > > snGrad (const scalarField &deltaCoeffs) const
 
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 void evaluate (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 wordcalculatedType ()
 
- Static Public Attributes inherited from fvPatchField< Type >
static int disallowGenericFvPatchField
 

Detailed Description

template<class Type>
class Foam::timeVaryingMappedFixedValueFvPatchField< Type >

This boundary conditions interpolates the values from a set of supplied points in space and time.

Supplied data should be specified in constant/boundaryData/<patchname>/

The default mode of operation (mapMethod planarInterpolation) is to project the points onto a plane (constructed from the first three points) and construct a 2D triangulation and finds for the face centres the triangle it is in and the weights to the 3 vertices.

The optional mapMethod nearest will avoid all projection and triangulation and just use the value at the nearest vertex.

Values are interpolated linearly between times.

Usage
Property Description Required Default
setAverage Use average value no false
perturb Perturb points for regular geometries no 1e-5
points Name of points file no points
fieldTable Alternative field name to sample no this field name
mapMethod Type of mapping no planarInterpolation
offset Offset to mapped values no Zero
    <patchName>
    {
        type            timeVaryingMappedFixedValue;
    }
See also
Foam::fixedValueFvPatchField Foam::Function1Types
Source files

Definition at line 123 of file timeVaryingMappedFixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ timeVaryingMappedFixedValueFvPatchField() [1/5]

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

Definition at line 30 of file timeVaryingMappedFixedValueFvPatchField.C.

◆ timeVaryingMappedFixedValueFvPatchField() [2/5]

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

Definition at line 43 of file timeVaryingMappedFixedValueFvPatchField.C.

References dict, Foam::stringOps::evaluate(), Foam::operator==(), and p.

Here is the call graph for this function:

◆ timeVaryingMappedFixedValueFvPatchField() [3/5]

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

Definition at line 80 of file timeVaryingMappedFixedValueFvPatchField.C.

◆ timeVaryingMappedFixedValueFvPatchField() [4/5]

Definition at line 102 of file timeVaryingMappedFixedValueFvPatchField.C.

◆ timeVaryingMappedFixedValueFvPatchField() [5/5]

Definition at line 121 of file timeVaryingMappedFixedValueFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "timeVaryingMappedFixedValue"  )

◆ clone() [1/2]

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

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 172 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ clone() [2/2]

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

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 189 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

Reimplemented from fvPatchField< Type >.

Definition at line 142 of file timeVaryingMappedFixedValueFvPatchField.C.

◆ rmap()

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

Reimplemented from fvPatchField< Type >.

Definition at line 153 of file timeVaryingMappedFixedValueFvPatchField.C.

References timeVaryingMappedFixedValueFvPatchField< Type >::rmap().

Referenced by timeVaryingMappedFixedValueFvPatchField< Type >::rmap().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateCoeffs()

void updateCoeffs
virtual

Reimplemented from fvPatchField< Type >.

Definition at line 168 of file timeVaryingMappedFixedValueFvPatchField.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::operator==(), and Foam::Pout.

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 192 of file timeVaryingMappedFixedValueFvPatchField.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

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