emptyLagrangianPatchField< Type > Class Template Reference

An empty boundary condition for Lagrangian. This is used for the patches that have normals that point outside of the space of the reduced dimensionality; e.g., the front and back planes of a two-dimensional slab. More...

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

Public Member Functions

 TypeName ("empty")
 Runtime type information. More...
 
 emptyLagrangianPatchField (const LagrangianPatch &, const regIOobject &)
 Construct from patch and internal field. More...
 
 emptyLagrangianPatchField (const LagrangianPatch &, const regIOobject &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 emptyLagrangianPatchField (const emptyLagrangianPatchField< Type > &)
 Construct as copy. More...
 
 emptyLagrangianPatchField (const emptyLagrangianPatchField< Type > &, const regIOobject &)
 Construct as copy setting the 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 the internal field reference. More...
 
virtual void evaluate (PstreamBuffers &, const LagrangianScalarInternalDynamicField &fraction)
 Evaluate the patch field. 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 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 LagrangianScalarInternalDynamicField &fraction)
 Initialise evaluation of the patch field. More...
 
virtual void write (Ostream &) const
 Write. 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::emptyLagrangianPatchField< Type >

An empty boundary condition for Lagrangian. This is used for the patches that have normals that point outside of the space of the reduced dimensionality; e.g., the front and back planes of a two-dimensional slab.

This operates in a manner identical to a symmetry condition. Properties are transformed to represent an identical element entering the domain with an opposite normal velocity and other vector and tensor quantities transformed.

Whether or not this is actually used is a matter for the cloud model. If the cloud model is also of reduced dimensionality and only moves in the two-dimensional plane or the one-dimensional line, then the elements will never track into the empty patches and this condition will never be used. If, on the other hand, the cloud model is still considered three-dimensional even when the Eulerian modelling is of reduced dimensionality, then the empty patches will be interacted with and this condition will be used.

Usage
Example specification:
<LagrangianPatchName>
{
    type            empty;
}
Source files

Definition at line 74 of file emptyLagrangianPatchField.H.

Constructor & Destructor Documentation

◆ emptyLagrangianPatchField() [1/4]

emptyLagrangianPatchField ( const LagrangianPatch p,
const regIOobject iIo 
)

Construct from patch and internal field.

Definition at line 33 of file emptyLagrangianPatchField.C.

◆ emptyLagrangianPatchField() [2/4]

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

Construct from patch, internal field and dictionary.

Definition at line 44 of file emptyLagrangianPatchField.C.

◆ emptyLagrangianPatchField() [3/4]

Construct as copy.

Definition at line 56 of file emptyLagrangianPatchField.C.

◆ emptyLagrangianPatchField() [4/4]

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

Construct as copy setting the internal field reference.

Definition at line 66 of file emptyLagrangianPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "empty"  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Implements LagrangianPatchField< Type >.

Definition at line 116 of file emptyLagrangianPatchField.H.

◆ clone() [2/2]

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

Construct and return a clone setting the internal field reference.

Implements LagrangianPatchField< Type >.

Definition at line 128 of file emptyLagrangianPatchField.H.

◆ evaluate()

void evaluate ( PstreamBuffers ,
const LagrangianScalarInternalDynamicField fraction 
)
virtual

Evaluate the patch field.

Reimplemented from LagrangianPatchField< Type >.

Definition at line 79 of file emptyLagrangianPatchField.C.

References Foam::I, mesh, Foam::sqr(), and Foam::transform().

Here is the call graph for this function:

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