Public Member Functions | List of all members
GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField Class Reference
Inheritance diagram for GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField:
Inheritance graph
[legend]
Collaboration diagram for GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField:
Collaboration graph
[legend]

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from FieldField< PatchField, Type >
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
- Public Types inherited from PtrList< PatchField< Type > >
typedef PatchField< Type > value_type
 Type of values the PtrList contains. More...
 
typedef PatchField< Type > & reference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const PatchField< Type > & const_reference
 Type that can be used for storing into constant PtrList::value_type. More...
 
- 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. More...
 
- Protected Member Functions inherited from PtrList< PatchField< Type > >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

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.

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 wantedPatchTypes,
const wordList actualPatchTypes = wordList() 
)

Construct from a BoundaryMesh,.

reference to the internal field and a wordList of patch types and optional the actual patch types (to override constraint patches)

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 readField ( const DimensionedField< Type, GeoMesh > &  field,
const dictionary dict 
)
void updateCoeffs ( )

Update the boundary condition coefficients.

Definition at line 469 of file GeometricBoundaryField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::evaluate(), forAll, Foam::Info, PtrList< PatchField< Type > >::operator[](), and patchi.

Referenced by GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::GeometricBoundaryField().

Here is the call graph for this function:

Here is the caller graph for this function:

void evaluate ( )
Foam::wordList types ( ) const

Return a list of the patch types.

Definition at line 556 of file GeometricBoundaryField.C.

References GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::boundaryInternalField(), forAll, patchi, and PtrList< T >::size().

Referenced by GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Return BoundaryField of the cell values neighbouring.

the boundary

Definition at line 574 of file GeometricBoundaryField.C.

References forAll, GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::interfaces(), PtrList< PatchField< Type > >::operator[](), and patchi.

Referenced by GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::types().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::LduInterfaceFieldPtrsList< Type > interfaces ( ) const
Foam::lduInterfaceFieldPtrsList scalarInterfaces ( ) const

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

pointing to interfaces being set

Definition at line 618 of file GeometricBoundaryField.C.

References forAll, GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::interfaces(), patchi, UPtrList< T >::set(), PtrList< PatchField< Type > >::size(), and GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::writeEntry().

Referenced by GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::interfaces().

Here is the call graph for this function:

Here is the caller graph for this function:

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)

Assignment to FieldField<PatchField, Type>

Definition at line 683 of file GeometricBoundaryField.C.

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

Here is the call graph for this function:

void operator= ( const Type &  t)

Assignment to Type.

Definition at line 694 of file GeometricBoundaryField.C.

References forAll, FieldField< PatchField, Type >::operator, FieldField< Field, Type >::operator=(), and PtrList< PatchField< Type > >::operator[]().

Here is the call graph for this function:

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 721 of file GeometricBoundaryField.C.

References forAll, FieldField< PatchField, Type >::operator, and PtrList< PatchField< Type > >::operator[]().

Here is the call graph for this function:

void operator== ( const Type &  t)

Forced assignment to Type.

Definition at line 735 of file GeometricBoundaryField.C.

References forAll, and PtrList< PatchField< Type > >::operator[]().

Here is the call graph for this function:


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