FreeFOAM The Cross-Platform CFD Toolkit
GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField Class Reference

#include <src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricField.H>


Detailed Description

template<class Type, template< class > class PatchField, class GeoMesh>
class Foam::GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField

Definition at line 105 of file GeometricField.H.

+ Inheritance diagram for GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField:
+ Collaboration diagram for GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField:

List of all members.

Public Member Functions

 GeometricBoundaryField (const BoundaryMesh &, const DimensionedInternalField &, const word &)
 Construct from a BoundaryMesh,.
 GeometricBoundaryField (const BoundaryMesh &, const DimensionedInternalField &, const wordList &)
 Construct from a BoundaryMesh,.
 GeometricBoundaryField (const BoundaryMesh &, const DimensionedInternalField &, const PtrList< PatchField< Type > > &)
 Construct from a BoundaryMesh,.
 GeometricBoundaryField (const DimensionedInternalField &, const GeometricBoundaryField &)
 Construct as copy setting the reference to the internal field.
 GeometricBoundaryField (const GeometricBoundaryField &)
 Construct as copy.
 GeometricBoundaryField (const BoundaryMesh &, const DimensionedInternalField &, const dictionary &)
 Construct from dictionary.
void updateCoeffs ()
 Update the boundary condition coefficients.
void evaluate ()
 Evaluate boundary conditions.
wordList types () const
 Return a list of the patch types.
GeometricBoundaryField boundaryInternalField () const
 Return BoundaryField of the cell values neighbouring.
lduInterfaceFieldPtrsList interfaces () const
 Return a list of pointers for each patch field with only those.
void writeEntry (const word &keyword, Ostream &os) const
 Write boundary field as dictionary entry.
void operator= (const GeometricBoundaryField &)
 Assignment to BoundaryField<Type, PatchField, BoundaryMesh>
void operator= (const FieldField< PatchField, Type > &)
 Assignment to FieldField<PatchField, Type>
void operator= (const Type &)
 Assignment to Type.
void operator== (const GeometricBoundaryField &)
 Forced assignment to.
void operator== (const FieldField< PatchField, Type > &)
 Forced assignment to FieldField<PatchField, Type>
void operator== (const Type &)
 Forced assignment to Type.
- Public Member Functions inherited from FieldField< PatchField, Type >
 FieldField ()
 Construct null.
 FieldField (const label)
 Construct given size.
 FieldField (const word &, const FieldField< PatchField, Type > &)
 Construct using the Field sizes from the given FieldField.
 FieldField (const FieldField< PatchField, Type > &)
 Construct as copy.
 FieldField (FieldField< PatchField, Type > &, bool reUse)
 Construct as copy or re-use as specified.
 FieldField (const PtrList< PatchField< Type > > &)
 Construct as copy of a PtrList<Field, Type>
 FieldField (Istream &)
 Construct as copy of tmp<FieldField>
tmp< FieldField< PatchField,
Type > > 
clone () const
 Clone.
void negate ()
 Negate this field.
tmp< FieldField< PatchField,
cmptType > > 
component (const direction) const
 Return a component field of the field.
void replace (const direction, const FieldField< PatchField, cmptType > &)
 Replace a component field of the field.
void replace (const direction, const cmptType &)
 Replace a component field of the field.
tmp< FieldField< PatchField,
Type > > 
T () const
 Return the field transpose (only defined for second rank tensors)
void operator= (const tmp< FieldField< PatchField, Type > > &)
void operator+= (const FieldField< PatchField, Type > &)
void operator+= (const tmp< FieldField< PatchField, Type > > &)
void operator+= (const Type &)
void operator-= (const FieldField< PatchField, Type > &)
void operator-= (const tmp< FieldField< PatchField, Type > > &)
void operator-= (const Type &)
void operator*= (const FieldField< PatchField, scalar > &)
void operator*= (const tmp< FieldField< PatchField, scalar > > &)
void operator*= (const scalar &)
void operator/= (const FieldField< PatchField, scalar > &)
void operator/= (const tmp< FieldField< PatchField, scalar > > &)
void operator/= (const scalar &)
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count.
int count () const
 Return the reference count.
bool okToDelete () const
 Return true if the reference count is zero.
void resetRefCount ()
 Reset the reference count to zero.
void operator++ ()
 Increment the reference count.
void operator++ (int)
 Increment the reference count.
void operator-- ()
 Decrement the reference count.
void operator-- (int)
 Decrement the reference count.
- Public Member Functions inherited from PtrList< PatchField< Type > >
 PtrList ()
 Null Constructor.
 PtrList (const label)
 Construct with length specified.
 PtrList (const PtrList< PatchField< Type > > &)
 Copy constructor.
 PtrList (const PtrList< PatchField< Type > > &, const CloneArg &)
 Copy constructor with additional argument for clone.
 PtrList (const Xfer< PtrList< PatchField< Type > > > &)
 Construct by transferring the parameter contents.
 PtrList (PtrList< PatchField< Type > > &, bool reUse)
 Construct as copy or re-use as specified.
 PtrList (const SLPtrList< PatchField< Type > > &)
 Construct as copy of SLPtrList<T>
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class.
 ~PtrList ()
label size () const
 Return the number of elements in the PtrList.
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero).
void setSize (const label)
 Reset size of PtrList. This can only be used to set the size.
void resize (const label)
 Reset size of PtrList. This can only be used to set the size.
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the.
void transfer (PtrList< PatchField< Type > > &)
 Transfer the contents of the argument PtrList into this PtrList.
Xfer< PtrList< PatchField
< Type > > > 
xfer ()
 Transfer contents to the Xfer container.
bool set (const label) const
 Is element set.
autoPtr< PatchField< Type > > set (const label, PatchField< Type > *)
 Set element. Return old element (can be NULL).
autoPtr< PatchField< Type > > set (const label, const autoPtr< PatchField< Type > > &)
autoPtr< PatchField< Type > > set (const label, const tmp< PatchField< Type > > &)
void reorder (const UList< label > &)
 Reorders elements. Ordering does not have to be done in.
const PatchField< Type > & operator[] (const label) const
 Return element const reference.
PatchField< Type > & operator[] (const label)
 Return element reference.
const PatchField< Type > * operator() (const label) const
 Return element const pointer.
PtrList< PatchField< Type > > & operator= (const PtrList< PatchField< Type > > &)
 Assignment.
iterator begin ()
 Return an iterator to begin traversing the PtrList.
iterator end ()
 Return an iterator to end traversing the PtrList.

Additional Inherited Members

- Public Types inherited from FieldField< PatchField, Type >
typedef pTraits< Type >::cmptType cmptType
 Component type.
- Public Types inherited from PtrList< PatchField< Type > >
typedef PatchField< Type > value_type
 Type of values the PtrList contains.
typedef PatchField< Type > & reference
 Type that can be used for storing into PtrList::value_type objects.
typedef const PatchField< Type > & const_reference
 Type that can be used for storing into constant PtrList::value_type.
- Static Public Member Functions inherited from FieldField< PatchField, Type >
static tmp< FieldField
< PatchField, Type > > 
NewCalculatedType (const FieldField< PatchField, Type2 > &ff)
 Return a pointer to a new calculatedFvPatchFieldField created on.

Constructor & Destructor Documentation

GeometricBoundaryField ( const BoundaryMesh ,
const DimensionedInternalField ,
const word  
)

Construct from a BoundaryMesh,.

reference to the internal field and a patch type

GeometricBoundaryField ( const BoundaryMesh ,
const DimensionedInternalField ,
const wordList  
)

Construct from a BoundaryMesh,.

reference to the internal field and a wordList of patch types

GeometricBoundaryField ( const BoundaryMesh ,
const DimensionedInternalField ,
const PtrList< PatchField< Type > > &   
)

Construct from a BoundaryMesh,.

reference to the internal field and a PtrList<PatchField<Type> >

Construct as copy setting the reference to the internal field.

Construct as copy.

Dangerous because Field may be set to a field which gets deleted Need new type of BoundaryField, one which is part of a geometric field for which snGrad etc. may be called and a free standing BoundaryField for which such operations are unavailable.

GeometricBoundaryField ( const BoundaryMesh ,
const DimensionedInternalField ,
const dictionary  
)

Construct from dictionary.


Member Function Documentation

void updateCoeffs ( )

Update the boundary condition coefficients.

Definition at line 261 of file GeometricBoundaryField.C.

References Foam::endl(), forAll, Foam::Info, and patchi.

Foam::wordList types ( ) const

Return a list of the patch types.

Definition at line 343 of file GeometricBoundaryField.C.

References forAll, patchi, and PtrList< T >::size().

Foam::GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField boundaryInternalField ( ) const

Return BoundaryField of the cell values neighbouring.

the boundary

Definition at line 361 of file GeometricBoundaryField.C.

References forAll, and patchi.

Foam::lduInterfaceFieldPtrsList interfaces ( ) const

Return a list of pointers for each patch field with only those.

pointing to interfaces being set

Definition at line 379 of file GeometricBoundaryField.C.

References forAll, patchi, and UPtrList< T >::set().

void writeEntry ( const word keyword,
Ostream os 
) const
void operator= ( const GeometricBoundaryField )

Assignment to BoundaryField<Type, PatchField, BoundaryMesh>

void operator= ( const FieldField< PatchField, Type > &  ptff)
void operator= ( const Type &  t)

Assignment to Type.

Reimplemented from FieldField< PatchField, Type >.

Definition at line 452 of file GeometricBoundaryField.C.

References FieldField< Field, Type >::operator=().

void operator== ( const GeometricBoundaryField )

Forced assignment to.

BoundaryField<Type, PatchField, BoundaryMesh>

void operator== ( const FieldField< PatchField, Type > &  ptff)

Forced assignment to FieldField<PatchField, Type>

Definition at line 479 of file GeometricBoundaryField.C.

References forAll.

void operator== ( const Type &  t)

Forced assignment to Type.

Definition at line 493 of file GeometricBoundaryField.C.

References forAll.


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