genericLagrangianPatchField< Type > Class Template Reference

This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types when post-processing or running mesh manipulation utilities. Not generally applicable as a user-specified condition. More...

Inheritance diagram for genericLagrangianPatchField< Type >:
Collaboration diagram for genericLagrangianPatchField< Type >:

Public Member Functions

 TypeName ("generic")
 Runtime type information. More...
 
 genericLagrangianPatchField (const LagrangianPatch &, const regIOobject &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 genericLagrangianPatchField (const genericLagrangianPatchField< Type > &)
 Construct as copy. More...
 
 genericLagrangianPatchField (const genericLagrangianPatchField< Type > &, const regIOobject &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< LagrangianPatchField< Type > > clone () const
 Construct and return a clone. More...
 
virtual autoPtr< LagrangianPatchField< Type > > clone (const regIOobject &iIo) const
 Construct and return a clone setting internal field reference. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from genericFieldBase
 TypeName ("generic")
 Runtime type information. More...
 
 genericFieldBase ()
 Construct null. More...
 
 genericFieldBase (const word &actualTypeName)
 Construct from actual type name. More...
 
virtual ~genericFieldBase ()
 Destructor. More...
 
const wordactualTypeName () const
 Return the actual type name. More...
 
- Public Member Functions inherited from calculatedLagrangianPatchField< Type >
 TypeName ("calculated")
 Runtime type information. More...
 
 calculatedLagrangianPatchField (const LagrangianPatch &, const regIOobject &)
 Construct from patch and internal field. More...
 
 calculatedLagrangianPatchField (const LagrangianPatch &, const regIOobject &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 calculatedLagrangianPatchField (const calculatedLagrangianPatchField< Type > &)
 Construct as copy. More...
 
 calculatedLagrangianPatchField (const calculatedLagrangianPatchField< Type > &, const regIOobject &)
 Construct as copy setting the internal field reference. More...
 
- Public Member Functions inherited from LagrangianPatchField< Type >
 TypeName ("LagrangianPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, LagrangianPatchField, LagrangianPatch,(const LagrangianPatch &p, const regIOobject &iIo),(p, iIo))
 Select given patch and internal field. More...
 
 declareRunTimeSelectionTable (autoPtr, LagrangianPatchField, dictionary,(const LagrangianPatch &p, const regIOobject &iIo, const dictionary &dict),(p, iIo, dict))
 Select given patch, internal field and dictionary. More...
 
 LagrangianPatchField (const LagrangianPatch &, const regIOobject &)
 Construct from patch and internal field. More...
 
 LagrangianPatchField (const LagrangianPatch &, const regIOobject &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 LagrangianPatchField (const LagrangianPatchField< Type > &)
 Construct as copy. More...
 
 LagrangianPatchField (const LagrangianPatchField< Type > &, const regIOobject &)
 Construct as copy setting the internal field reference. More...
 
 LagrangianPatchField (const LagrangianPatchField< Type > &, const LagrangianPatch &, const regIOobject &)
 Construct as copy setting the patch and the internal field reference. More...
 
virtual autoPtr< LagrangianPatchField< Type > > clone (const LagrangianPatch &, const regIOobject &) const
 Construct and return a clone onto a new patch. More...
 
virtual ~LagrangianPatchField ()
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const Timetime () const
 Return time. More...
 
const LagrangianPatchpatch () const
 Return patch. More...
 
const dimensionSetinternalDimensions () const
 Return internal dimensions reference. More...
 
const LagrangianInternalDynamicField< Type > & internalField () const
 Return internal field reference. More...
 
tmp< LagrangianSubSubField< Type > > internalSubField () const
 Generate an internal sub field corresponding to this patch. More...
 
SubField< Type > primitiveSubField () const
 Generate a primitive sub field corresponding to this patch. More...
 
virtual void reset (const LagrangianPatchField< Type > &)
 Reset to the given LagrangianPatchField. More...
 
virtual void initEvaluate (PstreamBuffers &, const LagrangianInternalScalarDynamicField &fraction)
 Initialise evaluation of the patch field. More...
 
virtual void evaluate (PstreamBuffers &, const LagrangianInternalScalarDynamicField &fraction)
 Evaluate the patch field. More...
 
tmp< LagrangianSubSubField< Type > > operator() () const
 Generate a sub-sub field corresponding to this patch. More...
 
virtual void operator= (const LagrangianPatchField< Type > &)
 
virtual void operator= (const LagrangianSubField< Type > &)
 
virtual void operator= (const LagrangianSubSubField< Type > &)
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const Type &)
 
virtual void operator== (const LagrangianPatchField< Type > &)
 
virtual void operator== (const LagrangianSubField< Type > &)
 
virtual void operator== (const LagrangianSubSubField< Type > &)
 
virtual void operator== (const UList< Type > &)
 
virtual void operator== (const Type &)
 
virtual void operator+= (const LagrangianPatchField< Type > &)
 
virtual void operator+= (const LagrangianSubField< Type > &)
 
virtual void operator+= (const LagrangianSubSubField< Type > &)
 
virtual void operator+= (const UList< Type > &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const LagrangianPatchField< Type > &)
 
virtual void operator-= (const LagrangianSubField< Type > &)
 
virtual void operator-= (const LagrangianSubSubField< Type > &)
 
virtual void operator-= (const UList< Type > &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const LagrangianPatchField< scalar > &)
 
virtual void operator*= (const LagrangianSubField< scalar > &)
 
virtual void operator*= (const LagrangianSubSubField< scalar > &)
 
virtual void operator*= (const UList< scalar > &)
 
virtual void operator*= (const scalar &)
 
virtual void operator/= (const LagrangianPatchField< scalar > &)
 
virtual void operator/= (const LagrangianSubField< scalar > &)
 
virtual void operator/= (const LagrangianSubSubField< scalar > &)
 
virtual void operator/= (const UList< scalar > &)
 
virtual void operator/= (const scalar &)
 
template<class Type2 >
Foam::autoPtr< Foam::LagrangianPatchField< Type > > NewCalculatedType (const LagrangianPatchField< Type2 > &pf)
 

Additional Inherited Members

- Public Types inherited from LagrangianPatchField< Type >
typedef LagrangianPatch Patch
 The patch type. More...
 
typedef calculatedLagrangianPatchField< Type > Calculated
 The calculated patch field type. More...
 
- Static Public Member Functions inherited from LagrangianPatchField< Type >
static autoPtr< LagrangianPatchField< Type > > New (const word &patchFieldType, const word &actualPatchType, const LagrangianPatch &p, const regIOobject &)
 Return a pointer to a new LagrangianPatchField with a given type. More...
 
static autoPtr< LagrangianPatchField< Type > > New (const word &, const LagrangianPatch &, const regIOobject &)
 Return a pointer to a new LagrangianPatchField with a given type. More...
 
static autoPtr< LagrangianPatchField< Type > > New (const LagrangianPatch &, const regIOobject &, const dictionary &)
 Return a pointer to a new LagrangianPatchField corresponding to a. More...
 
template<class Type2 >
static autoPtr< LagrangianPatchField< Type > > NewCalculatedType (const LagrangianPatchField< Type2 > &)
 Return a pointer to a new calculatedPointPatchField. More...
 
static const wordcalculatedType ()
 Return the type of the calculated form of LagrangianPatchField. More...
 
- Static Public Attributes inherited from LagrangianPatchField< Type >
static int disallowGenericLagrangianPatchField
 Debug switch to disallow the use of genericLagrangianPatchField. More...
 
- Protected Attributes inherited from LagrangianPatchField< Type >
const regIOobjectinternalIo_
 Reference to the internal IO object. More...
 
const LagrangianInternalDynamicField< Type > & internalField_
 Reference to the internal field. More...
 
const LagrangianInternalField< Type > & internalNonDynamicField_
 Reference to the non-dynamic internal field. More...
 

Detailed Description

template<class Type>
class Foam::genericLagrangianPatchField< Type >

This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types when post-processing or running mesh manipulation utilities. Not generally applicable as a user-specified condition.

See also
Foam::calculatedLagrangianPatchField
Source files

Definition at line 57 of file genericLagrangianPatchField.H.

Constructor & Destructor Documentation

◆ genericLagrangianPatchField() [1/3]

genericLagrangianPatchField ( const LagrangianPatch p,
const regIOobject iIo,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 31 of file genericLagrangianPatchField.C.

◆ genericLagrangianPatchField() [2/3]

Construct as copy.

Definition at line 45 of file genericLagrangianPatchField.C.

◆ genericLagrangianPatchField() [3/3]

genericLagrangianPatchField ( const genericLagrangianPatchField< Type > &  ptf,
const regIOobject iIo 
)

Construct as copy setting internal field reference.

Definition at line 57 of file genericLagrangianPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "generic"  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Reimplemented from calculatedLagrangianPatchField< Type >.

Definition at line 98 of file genericLagrangianPatchField.H.

◆ clone() [2/2]

virtual autoPtr<LagrangianPatchField<Type> > clone ( const regIOobject iIo) const
inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from calculatedLagrangianPatchField< Type >.

Definition at line 107 of file genericLagrangianPatchField.H.

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from LagrangianPatchField< Type >.

Definition at line 72 of file genericLagrangianPatchField.C.

References forAllConstIter, and Foam::writeEntry().

Here is the call graph for this function:

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