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

A time-varying form of a mapped fixed value boundary condition. More...

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

Public Member Functions

 TypeName ("timeVaryingMappedFixedValue")
 Runtime type information. More...
 
 timeVaryingMappedFixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field. More...
 
 timeVaryingMappedFixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 timeVaryingMappedFixedValuePointPatchField (const timeVaryingMappedFixedValuePointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patch field onto a new patch. More...
 
 timeVaryingMappedFixedValuePointPatchField (const timeVaryingMappedFixedValuePointPatchField< Type > &)
 Construct as copy. More...
 
virtual autoPtr< pointPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 timeVaryingMappedFixedValuePointPatchField (const timeVaryingMappedFixedValuePointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchField< Type > > clone (const DimensionedField< Type, pointMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
void checkTable ()
 Find boundary data inbetween current time and interpolate. More...
 
virtual void autoMap (const pointPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const pointPatchField< Type > &, const labelList &)
 Reverse map the given PointPatchField onto. 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 fixedValuePointPatchField< Type >
 TypeName ("fixedValue")
 Runtime type information. More...
 
 fixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field. More...
 
 fixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 fixedValuePointPatchField (const fixedValuePointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch. More...
 
 fixedValuePointPatchField (const fixedValuePointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
virtual void operator= (const Field< Type > &)
 
virtual void operator= (const Type &)
 
- Public Member Functions inherited from valuePointPatchField< Type >
 TypeName ("value")
 Runtime type information. More...
 
 valuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field. More...
 
 valuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 valuePointPatchField (const valuePointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch. More...
 
 valuePointPatchField (const valuePointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
label size () const
 Return size. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Evaluate the patch field. More...
 
virtual void operator= (const valuePointPatchField< Type > &)
 
virtual void operator= (const pointPatchField< Type > &)
 
virtual void operator== (const valuePointPatchField< Type > &)
 
virtual void operator== (const pointPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
- Public Member Functions inherited from pointPatchField< Type >
 TypeName ("pointPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, pointPatch,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m),(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field. More...
 
 pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch. More...
 
 pointPatchField (const pointPatchField< Type > &)
 Construct as copy. More...
 
 pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchField< Type > > clone () const=0
 Construct and return a clone. More...
 
virtual ~pointPatchField ()
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
label size () const
 Return size. More...
 
const pointPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, pointMesh > & 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...
 
tmp< Field< Type > > patchInternalField () const
 Return field created from appropriate internal field values. More...
 
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 Return field created from appropriate internal field values. More...
 
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 Return field created from selected internal field values. More...
 
tmp< Field< Type > > patchInternalField () const
 
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,. More...
 
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
 Given the internal field and a patch field,. More...
 
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
 Given the internal field and a patch field,. More...
 
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,. More...
 
virtual const wordconstraintType () const
 Return the constraint type this pointPatchField implements. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Initialise evaluation of the patch field (do nothing) More...
 
virtual void operator+= (const pointPatchField< Type > &)
 
virtual void operator+= (const Field< Type > &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const pointPatchField< Type > &)
 
virtual void operator-= (const Field< Type > &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const pointPatchField< scalar > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const pointPatchField< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator/= (const scalar)
 
- Public Member Functions inherited from Field< Type >
 Field ()
 Construct null. More...
 
 Field (const label)
 Construct given size. More...
 
 Field (const label, const Type &)
 Construct given size and initial value. More...
 
 Field (const UList< Type > &)
 Construct as copy of a UList<Type> More...
 
 Field (const Xfer< List< Type > > &)
 Construct by transferring the List contents. More...
 
 Field (const UList< Type > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given tmp field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given tmp field. Supplied uniform. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given tmp field. Supplied values. More...
 
 Field (const Field< Type > &)
 Construct as copy. More...
 
 Field (Field< Type > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 Field (const Xfer< Field< Type > > &)
 Construct by transferring the Field contents. More...
 
 Field (const tmp< Field< Type > > &)
 Construct as copy of tmp<Field> More...
 
 Field (Istream &)
 Construct from Istream. More...
 
 Field (const word &keyword, const dictionary &, const label size)
 Construct from a dictionary entry. More...
 
tmp< Field< Type > > clone () const
 Clone. More...
 
void map (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field More...
 
void map (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field More...
 
void map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field. More...
 
void map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field. More...
 
void map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given field. More...
 
void map (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given tmp field. More...
 
void autoMap (const FieldMapper &map, const bool applyFlip=true)
 Map from self. More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field More...
 
void rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field. More...
 
void rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field. More...
 
void negate ()
 Negate this field. More...
 
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const tmp< Field< cmptType > > &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
tmp< Field< Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the field as a dictionary entry. More...
 
void operator= (const Field< Type > &)
 
void operator= (const UList< Type > &)
 
void operator= (const SubField< Type > &)
 
void operator= (const tmp< Field< Type > > &)
 
void operator= (const Type &)
 
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
 
void operator= (const Field< Type > &rhs)
 
void operator= (const SubField< Type > &rhs)
 
void operator= (const UList< Type > &rhs)
 
void operator= (const tmp< Field > &rhs)
 
void operator= (const Type &t)
 
void operator+= (const UList< Type > &)
 
void operator+= (const tmp< Field< Type > > &)
 
void operator+= (const Type &)
 
void operator-= (const UList< Type > &)
 
void operator-= (const tmp< Field< Type > > &)
 
void operator-= (const Type &)
 
void operator*= (const UList< scalar > &)
 
void operator*= (const tmp< Field< scalar > > &)
 
void operator*= (const scalar &)
 
void operator/= (const UList< scalar > &)
 
void operator/= (const tmp< Field< scalar > > &)
 
void operator/= (const scalar &)
 

Private Attributes

word fieldTableName_
 Name of the field data table, defaults to the name of the field. More...
 
bool setAverage_
 If true adjust the mapped field to maintain average value. More...
 
scalar perturb_
 Fraction of perturbation (fraction of bounding box) to add. More...
 
word mapMethod_
 Interpolation scheme to use. More...
 
autoPtr< pointToPointPlanarInterpolationmapperPtr_
 2D interpolation (for 'planarInterpolation' mapMethod) More...
 
instantList sampleTimes_
 List of boundaryData time directories. More...
 
label startSampleTime_
 Current starting index in sampleTimes. More...
 
Field< Type > startSampledValues_
 Interpolated values from startSampleTime. More...
 
Type startAverage_
 If setAverage: starting average value. More...
 
label endSampleTime_
 Current end index in sampleTimes. More...
 
Field< Type > endSampledValues_
 Interpolated values from endSampleTime. More...
 
Type endAverage_
 If setAverage: end average value. More...
 
autoPtr< DataEntry< Type > > offset_
 Time varying offset values to interpolated data. More...
 

Additional Inherited Members

- Public Types inherited from pointPatchField< Type >
typedef pointPatch Patch
 
- Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
typedef SubField< Type > subField
 Declare type of subField. More...
 
- Static Public Member Functions inherited from pointPatchField< Type >
static autoPtr< pointPatchField< Type > > New (const word &, const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static autoPtr< pointPatchField< Type > > New (const word &, const word &actualPatchType, const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static autoPtr< pointPatchField< Type > > New (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static autoPtr< pointPatchField< Type > > New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
static autoPtr< pointPatchField< Type > > NewCalculatedType (const pointPatchField< Type2 > &)
 Return a pointer to a new CalculatedpointPatchField created on. More...
 
static const wordcalculatedType ()
 Return the type of the calculated form of pointPatchField. More...
 
- Static Public Member Functions inherited from Field< Type >
static const Field< Type > & null ()
 Return a null field. More...
 
static tmp< Field< Type > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on. More...
 
- Static Public Attributes inherited from pointPatchField< Type >
static int disallowGenericPointPatchField
 Debug switch to disallow the use of genericPointPatchField. More...
 
- Static Public Attributes inherited from Field< Type >
static const char *const typeName
 

Detailed Description

template<class Type>
class Foam::timeVaryingMappedFixedValuePointPatchField< Type >

A time-varying form of a mapped fixed value boundary condition.

See also
Foam::timeVaryingMappedFixedValueFvPatchField
Source files

Definition at line 55 of file timeVaryingMappedFixedValuePointPatchField.H.

Constructor & Destructor Documentation

◆ timeVaryingMappedFixedValuePointPatchField() [1/5]

Construct from patch and internal field.

Definition at line 36 of file timeVaryingMappedFixedValuePointPatchField.C.

◆ timeVaryingMappedFixedValuePointPatchField() [2/5]

timeVaryingMappedFixedValuePointPatchField ( const pointPatch p,
const DimensionedField< Type, pointMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 94 of file timeVaryingMappedFixedValuePointPatchField.C.

References dict, Foam::compressible::New(), and p.

Here is the call graph for this function:

◆ timeVaryingMappedFixedValuePointPatchField() [3/5]

Construct by mapping given patch field onto a new patch.

Definition at line 61 of file timeVaryingMappedFixedValuePointPatchField.C.

◆ timeVaryingMappedFixedValuePointPatchField() [4/5]

Construct as copy.

Definition at line 151 of file timeVaryingMappedFixedValuePointPatchField.C.

◆ timeVaryingMappedFixedValuePointPatchField() [5/5]

Construct as copy setting internal field reference.

Definition at line 181 of file timeVaryingMappedFixedValuePointPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "timeVaryingMappedFixedValue"  )

Runtime type information.

◆ clone() [1/2]

virtual autoPtr<pointPatchField<Type> > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from fixedValuePointPatchField< Type >.

Definition at line 140 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ clone() [2/2]

virtual autoPtr<pointPatchField<Type> > clone ( const DimensionedField< Type, pointMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from fixedValuePointPatchField< Type >.

Definition at line 157 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ checkTable()

void checkTable

◆ autoMap()

void autoMap ( const pointPatchFieldMapper m)
virtual

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

Reimplemented from valuePointPatchField< Type >.

Definition at line 212 of file timeVaryingMappedFixedValuePointPatchField.C.

◆ rmap()

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

Reverse map the given PointPatchField onto.

this PointPatchField

Reimplemented from valuePointPatchField< Type >.

Definition at line 231 of file timeVaryingMappedFixedValuePointPatchField.C.

References timeVaryingMappedFixedValuePointPatchField< Type >::endSampledValues_, timeVaryingMappedFixedValuePointPatchField< Type >::rmap(), and timeVaryingMappedFixedValuePointPatchField< Type >::startSampledValues_.

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

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

◆ updateCoeffs()

void updateCoeffs
virtual

Update the coefficients associated with the patch field.

Reimplemented from valuePointPatchField< Type >.

Definition at line 486 of file timeVaryingMappedFixedValuePointPatchField.C.

References Foam::endl(), fld(), Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::mag(), OSstream::name(), fileName::name(), Foam::nl, Foam::operator==(), Foam::Pout, and s().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from valuePointPatchField< Type >.

Definition at line 592 of file timeVaryingMappedFixedValuePointPatchField.C.

References dimensionedInternalField(), Foam::constant::electromagnetic::e, Foam::name(), Foam::nl, write(), and Ostream::writeKeyword().

Here is the call graph for this function:

Field Documentation

◆ fieldTableName_

word fieldTableName_
private

Name of the field data table, defaults to the name of the field.

Definition at line 62 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ setAverage_

bool setAverage_
private

If true adjust the mapped field to maintain average value.

Definition at line 65 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ perturb_

scalar perturb_
private

Fraction of perturbation (fraction of bounding box) to add.

Definition at line 68 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ mapMethod_

word mapMethod_
private

Interpolation scheme to use.

Definition at line 71 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ mapperPtr_

2D interpolation (for 'planarInterpolation' mapMethod)

Definition at line 74 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ sampleTimes_

instantList sampleTimes_
private

List of boundaryData time directories.

Definition at line 77 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ startSampleTime_

label startSampleTime_
private

Current starting index in sampleTimes.

Definition at line 80 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ startSampledValues_

Field<Type> startSampledValues_
private

Interpolated values from startSampleTime.

Definition at line 83 of file timeVaryingMappedFixedValuePointPatchField.H.

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

◆ startAverage_

Type startAverage_
private

If setAverage: starting average value.

Definition at line 86 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ endSampleTime_

label endSampleTime_
private

Current end index in sampleTimes.

Definition at line 89 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ endSampledValues_

Field<Type> endSampledValues_
private

Interpolated values from endSampleTime.

Definition at line 92 of file timeVaryingMappedFixedValuePointPatchField.H.

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

◆ endAverage_

Type endAverage_
private

If setAverage: end average value.

Definition at line 95 of file timeVaryingMappedFixedValuePointPatchField.H.

◆ offset_

autoPtr<DataEntry<Type> > offset_
private

Time varying offset values to interpolated data.

Definition at line 98 of file timeVaryingMappedFixedValuePointPatchField.H.


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