FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

slicedFvPatchField< Type > Class Template Reference

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

#include <finiteVolume/slicedFvPatchField.H>


Detailed Description

template<class Type>
class Foam::slicedFvPatchField< Type >

Specialization of fvPatchField which creates the underlying fvPatchField 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 56 of file slicedFvPatchField.H.

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

List of all members.

Public Member Functions

 TypeName ("sliced")
 Runtime type information.
 slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 Construct from patch, internal field and field to slice.
 slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. Assign value later.
 slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 slicedFvPatchField (const slicedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given slicedFvPatchField<Type>
 slicedFvPatchField (const slicedFvPatchField< Type > &)
 Construct as copy.
virtual tmp< fvPatchField< Type > >  clone () const
 Construct and return a clone.
 slicedFvPatchField (const slicedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField< Type > >  clone (const DimensionedField< Type, volMesh > &iF) const
 Construct and return a clone setting internal field reference.
virtual  ~slicedFvPatchField ()
virtual bool  fixesValue () const
 Return true if this patch field fixes a value.
virtual tmp< Field< Type > >  snGrad () const
 Return patch-normal gradient.
virtual void  updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual tmp< Field< Type > >  patchInternalField () const
 Return internal field next to patch as patch field.
virtual tmp< Field< Type > >  patchNeighbourField (const Field< Type > &iField) const
 Return neighbour coupled given internal cell data.
virtual tmp< Field< Type > >  patchNeighbourField () const
 Return patchField of the values on the patch or on the.
virtual void  initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Initialise the evaluation of the patch field.
virtual void  evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Evaluate the patch field, sets Updated to false.
virtual tmp< Field< Type > >  valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the.
virtual tmp< Field< Type > >  valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the.
virtual tmp< Field< Type > >  gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the.
virtual tmp< Field< Type > >  gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the.
virtual void  write (Ostream &) const
 Write.
virtual void  operator= (const UList< Type > &)
 Assignment from UList operator. Takes linear time.
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 &)
 Assignment of all entries to the given value.
virtual void  operator+= (const Type &)
virtual void  operator-= (const Type &)
virtual void  operator*= (const scalar)
virtual void  operator/= (const scalar)

Constructor & Destructor Documentation

slicedFvPatchField ( const fvPatch &   p,
const DimensionedField< Type, volMesh > &   iF,
const Field< Type > &   completeField  
)

Construct from patch, internal field and field to slice.

Definition at line 37 of file slicedFvPatchField.C.

References UList< T >::operator=(), and fvPatch::patchSlice().

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

Construct from patch and internal field. Assign value later.

Definition at line 52 of file slicedFvPatchField.C.

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

Construct from patch, internal field and dictionary.

Definition at line 83 of file slicedFvPatchField.C.

References notImplemented.

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

Construct by mapping the given slicedFvPatchField<Type>

onto a new patch

Definition at line 63 of file slicedFvPatchField.C.

References notImplemented.

slicedFvPatchField ( const slicedFvPatchField< Type > &   ptf  )

Construct as copy.

Definition at line 124 of file slicedFvPatchField.C.

References UList< T >::operator=().

slicedFvPatchField ( const slicedFvPatchField< Type > &   ptf,
const DimensionedField< Type, volMesh > &   iF  
)

Construct as copy setting internal field reference.

Definition at line 101 of file slicedFvPatchField.C.

References UList< T >::operator=().

~slicedFvPatchField< Type > (  ) [virtual]

Definition at line 154 of file slicedFvPatchField.C.

References UList< T >::operator=().


Member Function Documentation

TypeName ( "sliced"    )

Runtime type information.

tmp< fvPatchField< Type > > clone (  ) const [virtual]

Construct and return a clone.

Reimplemented from fvPatchField< Type >.

Definition at line 113 of file slicedFvPatchField.C.

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

Construct and return a clone setting internal field reference.

Reimplemented from fvPatchField< Type >.

Definition at line 142 of file slicedFvPatchField.C.

virtual bool fixesValue (  ) const [inline, virtual]

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 fvPatchField< Type >.

Definition at line 134 of file slicedFvPatchField.H.

tmp< Field< Type > > snGrad (  ) const [virtual]

Return patch-normal gradient.

Reimplemented from fvPatchField< Type >.

Definition at line 165 of file slicedFvPatchField.C.

References notImplemented, and Field< Type >::null().

void updateCoeffs (  ) [virtual]

Update the coefficients associated with the patch field.

Sets Updated to true

Reimplemented from fvPatchField< Type >.

Definition at line 178 of file slicedFvPatchField.C.

References notImplemented.

tmp< Field< Type > > patchInternalField (  ) const [virtual]

Return internal field next to patch as patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 189 of file slicedFvPatchField.C.

References notImplemented, and Field< Type >::null().

tmp< Field< Type > > patchNeighbourField ( const Field< Type > &   iField  ) const [virtual]

Return neighbour coupled given internal cell data.

Definition at line 203 of file slicedFvPatchField.C.

References notImplemented, and Field< Type >::null().

tmp< Field< Type > > patchNeighbourField (  ) const [virtual]

Return patchField of the values on the patch or on the.

opposite patch

Reimplemented from fvPatchField< Type >.

Definition at line 218 of file slicedFvPatchField.C.

References notImplemented, and Field< Type >::null().

virtual void initEvaluate ( const Pstream::commsTypes   commsType = Pstream::blocking  ) [inline, virtual]

Initialise the evaluation of the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 164 of file slicedFvPatchField.H.

virtual void evaluate ( const Pstream::commsTypes   commsType = Pstream::blocking  ) [inline, virtual]

Evaluate the patch field, sets Updated to false.

Reimplemented from fvPatchField< Type >.

Definition at line 171 of file slicedFvPatchField.H.

tmp< Field< Type > > valueInternalCoeffs ( const tmp< scalarField > &    ) const [virtual]

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Reimplemented from fvPatchField< Type >.

Definition at line 232 of file slicedFvPatchField.C.

References notImplemented, and Field< Type >::null().

tmp< Field< Type > > valueBoundaryCoeffs ( const tmp< scalarField > &    ) const [virtual]

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Reimplemented from fvPatchField< Type >.

Definition at line 248 of file slicedFvPatchField.C.

References notImplemented, and Field< Type >::null().

tmp< Field< Type > > gradientInternalCoeffs (  ) const [virtual]

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField< Type >.

Definition at line 263 of file slicedFvPatchField.C.

References notImplemented, and Field< Type >::null().

tmp< Field< Type > > gradientBoundaryCoeffs (  ) const [virtual]

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField< Type >.

Definition at line 276 of file slicedFvPatchField.C.

References notImplemented, and Field< Type >::null().

void write ( Ostream &   os  ) const [virtual]

Write.

Reimplemented from fvPatchField< Type >.

Definition at line 289 of file slicedFvPatchField.C.

References fvPatchField< Type >::write().

virtual void operator= ( const UList< Type > &    ) [inline, virtual]

Assignment from UList operator. Takes linear time.

Reimplemented from fvPatchField< Type >.

Definition at line 205 of file slicedFvPatchField.H.

virtual void operator= ( const fvPatchField< Type > &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 207 of file slicedFvPatchField.H.

virtual void operator+= ( const fvPatchField< Type > &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 208 of file slicedFvPatchField.H.

virtual void operator-= ( const fvPatchField< Type > &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 209 of file slicedFvPatchField.H.

virtual void operator*= ( const fvPatchField< scalar > &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 210 of file slicedFvPatchField.H.

virtual void operator/= ( const fvPatchField< scalar > &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 211 of file slicedFvPatchField.H.

virtual void operator+= ( const Field< Type > &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 213 of file slicedFvPatchField.H.

virtual void operator-= ( const Field< Type > &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 214 of file slicedFvPatchField.H.

virtual void operator*= ( const Field< scalar > &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 216 of file slicedFvPatchField.H.

virtual void operator/= ( const Field< scalar > &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 217 of file slicedFvPatchField.H.

virtual void operator= ( const Type &    ) [inline, virtual]

Assignment of all entries to the given value.

Reimplemented from fvPatchField< Type >.

Definition at line 219 of file slicedFvPatchField.H.

virtual void operator+= ( const Type &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 220 of file slicedFvPatchField.H.

virtual void operator-= ( const Type &    ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 221 of file slicedFvPatchField.H.

virtual void operator*= ( const   scalar  ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 222 of file slicedFvPatchField.H.

virtual void operator/= ( const   scalar  ) [inline, virtual]

Reimplemented from fvPatchField< Type >.

Definition at line 223 of file slicedFvPatchField.H.


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