slicedFvsPatchField< Type > Class Template Reference

Specialization of fvsPatchField which creates the underlying fvsPatchField as a slice of the given complete field. More...

Inheritance diagram for slicedFvsPatchField< Type >:
[legend]
Collaboration diagram for slicedFvsPatchField< Type >:
[legend]

Public Member Functions

 TypeName ("sliced")
 Runtime type information. More...
 
 slicedFvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const Field< Type > &)
 Construct from patch, internal field and field to slice. More...
 
 slicedFvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
 Construct from patch and internal field. More...
 
 slicedFvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 slicedFvsPatchField (const slicedFvsPatchField< Type > &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given slicedFvsPatchField<Type> More...
 
 slicedFvsPatchField (const slicedFvsPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< fvsPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 slicedFvsPatchField (const slicedFvsPatchField< Type > &, const DimensionedField< Type, surfaceMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvsPatchField< Type > > clone (const DimensionedField< Type, surfaceMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~slicedFvsPatchField ()
 Destructor. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const fvsPatchField< Type > &)
 
virtual void operator+= (const fvsPatchField< Type > &)
 
virtual void operator-= (const fvsPatchField< Type > &)
 
virtual void operator*= (const fvsPatchField< scalar > &)
 
virtual void operator/= (const fvsPatchField< 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 fvsPatchField< Type >
 TypeName ("fvsPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, fvsPatchField, patch,(const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (tmp, fvsPatchField, patchMapper,(const fvsPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvsPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (tmp, fvsPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
 Construct from patch and internal field. More...
 
 fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 fvsPatchField (const fvsPatchField< Type > &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvsPatchField onto a new patch. More...
 
 fvsPatchField (const fvsPatchField< Type > &)
 Construct as copy. More...
 
 fvsPatchField (const fvsPatchField< Type > &, const DimensionedField< Type, surfaceMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual ~fvsPatchField ()=default
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const fvPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, surfaceMesh > & internalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & primitiveField () const
 Return internal field reference. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvsPatchField< Type > &, const labelList &)
 Reverse map the given fvsPatchField onto this fvsPatchField. More...
 
virtual void write (Ostream &) const
 Write. More...
 
void check (const fvsPatchField< Type > &) const
 Check fvsPatchField<Type> against given fvsPatchField<Type> More...
 
virtual void operator== (const fvsPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
template<class Type2 >
Foam::tmp< Foam::fvsPatchField< Type > > NewCalculatedType (const fvsPatchField< Type2 > &pf)
 

Additional Inherited Members

- Public Types inherited from fvsPatchField< Type >
typedef fvPatch Patch
 
typedef calculatedFvsPatchField< Type > Calculated
 
- Static Public Member Functions inherited from fvsPatchField< Type >
static tmp< fvsPatchField< Type > > New (const word &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvsPatchField< Type > > New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvsPatchField< Type > > New (const fvsPatchField< Type > &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const fvPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static tmp< fvsPatchField< Type > > New (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
static tmp< fvsPatchField< Type > > NewCalculatedType (const fvPatch &)
 Return a pointer to a new calculatedFvsPatchField created on. More...
 
template<class Type2 >
static tmp< fvsPatchField< Type > > NewCalculatedType (const fvsPatchField< Type2 > &)
 Return a pointer to a new calculatedFvsPatchField created on. More...
 
static const wordcalculatedType ()
 Return the type of the calculated for of fvsPatchField. More...
 
- Static Public Attributes inherited from fvsPatchField< Type >
static int disallowGenericFvsPatchField
 Debug switch to disallow the use of genericFvsPatchField. More...
 

Detailed Description

template<class Type>
class Foam::slicedFvsPatchField< Type >

Specialization of fvsPatchField which creates the underlying fvsPatchField as a slice of the given complete field.

The destructor is wrapped to avoid deallocation of the storage of the complete fields when this is destroyed.

Should only used as a template argument for SlicedGeometricField.

Source files

Definition at line 57 of file slicedFvsPatchField.H.

Constructor & Destructor Documentation

◆ slicedFvsPatchField() [1/6]

slicedFvsPatchField ( const fvPatch p,
const DimensionedField< Type, surfaceMesh > &  iF,
const Field< Type > &  completeField 
)

Construct from patch, internal field and field to slice.

Definition at line 34 of file slicedFvsPatchField.C.

References p.

◆ slicedFvsPatchField() [2/6]

slicedFvsPatchField ( const fvPatch p,
const DimensionedField< Type, surfaceMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 49 of file slicedFvsPatchField.C.

◆ slicedFvsPatchField() [3/6]

slicedFvsPatchField ( const fvPatch p,
const DimensionedField< Type, surfaceMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 60 of file slicedFvsPatchField.C.

References NotImplemented.

◆ slicedFvsPatchField() [4/6]

slicedFvsPatchField ( const slicedFvsPatchField< Type > &  ptf,
const fvPatch p,
const DimensionedField< Type, surfaceMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Construct by mapping the given slicedFvsPatchField<Type>

onto a new patch

Definition at line 74 of file slicedFvsPatchField.C.

References NotImplemented.

◆ slicedFvsPatchField() [5/6]

slicedFvsPatchField ( const slicedFvsPatchField< Type > &  ptf)

Construct as copy.

Definition at line 114 of file slicedFvsPatchField.C.

◆ slicedFvsPatchField() [6/6]

slicedFvsPatchField ( const slicedFvsPatchField< Type > &  ptf,
const DimensionedField< Type, surfaceMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 89 of file slicedFvsPatchField.C.

◆ ~slicedFvsPatchField()

~slicedFvsPatchField ( )
virtual

Destructor.

Definition at line 145 of file slicedFvsPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "sliced"  )

Runtime type information.

◆ clone() [1/2]

Foam::tmp< Foam::fvsPatchField< Type > > clone ( ) const
virtual

Construct and return a clone.

Reimplemented from fvsPatchField< Type >.

Definition at line 103 of file slicedFvsPatchField.C.

◆ clone() [2/2]

Foam::tmp< Foam::fvsPatchField< Type > > clone ( const DimensionedField< Type, surfaceMesh > &  iF) const
virtual

Construct and return a clone setting internal field reference.

Reimplemented from fvsPatchField< Type >.

Definition at line 133 of file slicedFvsPatchField.C.

◆ fixesValue()

virtual bool fixesValue ( ) const
inlinevirtual

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations.

Reimplemented from fvsPatchField< Type >.

Definition at line 134 of file slicedFvsPatchField.H.

◆ operator=() [1/3]

virtual void operator= ( const UList< Type > &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 142 of file slicedFvsPatchField.H.

◆ operator=() [2/3]

virtual void operator= ( const fvsPatchField< Type > &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 144 of file slicedFvsPatchField.H.

◆ operator+=() [1/3]

virtual void operator+= ( const fvsPatchField< Type > &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 145 of file slicedFvsPatchField.H.

◆ operator-=() [1/3]

virtual void operator-= ( const fvsPatchField< Type > &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 146 of file slicedFvsPatchField.H.

◆ operator*=() [1/3]

virtual void operator*= ( const fvsPatchField< scalar > &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 147 of file slicedFvsPatchField.H.

◆ operator/=() [1/3]

virtual void operator/= ( const fvsPatchField< scalar > &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 148 of file slicedFvsPatchField.H.

◆ operator+=() [2/3]

virtual void operator+= ( const Field< Type > &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 150 of file slicedFvsPatchField.H.

◆ operator-=() [2/3]

virtual void operator-= ( const Field< Type > &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 151 of file slicedFvsPatchField.H.

◆ operator*=() [2/3]

virtual void operator*= ( const Field< scalar > &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 153 of file slicedFvsPatchField.H.

◆ operator/=() [2/3]

virtual void operator/= ( const Field< scalar > &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 154 of file slicedFvsPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 156 of file slicedFvsPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 157 of file slicedFvsPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type &  )
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 158 of file slicedFvsPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const  scalar)
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 159 of file slicedFvsPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const  scalar)
inlinevirtual

Reimplemented from fvsPatchField< Type >.

Definition at line 160 of file slicedFvsPatchField.H.


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