Public Types | Public Member Functions | List of all members
GeometricFieldSources< Type, GeoMesh > Class Template Reference

Part of a geometric field used for setting the values associated with optional sources. More...

Inheritance diagram for GeometricFieldSources< Type, GeoMesh >:
Inheritance graph
[legend]
Collaboration diagram for GeometricFieldSources< Type, GeoMesh >:
Collaboration graph
[legend]

Public Types

typedef DimensionedField< Type, GeoMesh > Internal
 Type of the internal field from which this GeometricField is derived. More...
 
typedef GeoMesh::template FieldSource< Type > Source
 Type of the field source of which this field sources is composed. More...
 

Public Member Functions

 GeometricFieldSources ()
 Construct null. More...
 
 GeometricFieldSources (const Internal &, const HashPtrTable< Source > &)
 Construct from a table of field sources. More...
 
 GeometricFieldSources (const Internal &, const GeometricFieldSources &)
 Construct as copy setting the reference to the internal field. More...
 
 GeometricFieldSources (const Internal &, const dictionary &)
 Construct from dictionary. More...
 
 GeometricFieldSources (const Internal &, const HashTable< word > &)
 Construct from types. More...
 
 GeometricFieldSources (const GeometricFieldSources &)=delete
 Copy constructor deleted. More...
 
 GeometricFieldSources (GeometricFieldSources &&)=delete
 Move constructor deleted. More...
 
 ~GeometricFieldSources ()
 Destructor. More...
 
const HashPtrTable< Source > & table () const
 Access the underlying field table. More...
 
HashPtrTable< Source > & table ()
 Access the underlying field table. More...
 
HashTable< word > types () const
 Return a map from the source name to the field source type. More...
 
void readField (const Internal &field, const dictionary &dict)
 Read the sources. More...
 
void reset (const GeometricFieldSources &)
 Reset the boundary field contents to the given field. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write sources as dictionary entry. More...
 
const Source & operator[] (const word &sourceName) const
 Find and return a field source. More...
 

Detailed Description

template<class Type, class GeoMesh>
class Foam::GeometricFieldSources< Type, GeoMesh >

Part of a geometric field used for setting the values associated with optional sources.

Source files

Definition at line 54 of file GeometricFieldSources.H.

Member Typedef Documentation

◆ Internal

typedef DimensionedField<Type, GeoMesh> Internal

Type of the internal field from which this GeometricField is derived.

Definition at line 63 of file GeometricFieldSources.H.

◆ Source

typedef GeoMesh::template FieldSource<Type> Source

Type of the field source of which this field sources is composed.

Definition at line 66 of file GeometricFieldSources.H.

Constructor & Destructor Documentation

◆ GeometricFieldSources() [1/7]

GeometricFieldSources

Construct null.

Definition at line 31 of file GeometricFieldSources.C.

◆ GeometricFieldSources() [2/7]

GeometricFieldSources ( const Internal &  ,
const HashPtrTable< Source > &   
)

Construct from a table of field sources.

◆ GeometricFieldSources() [3/7]

GeometricFieldSources ( const Internal &  ,
const GeometricFieldSources< Type, GeoMesh > &   
)

Construct as copy setting the reference to the internal field.

◆ GeometricFieldSources() [4/7]

GeometricFieldSources ( const Internal &  ,
const dictionary &   
)

Construct from dictionary.

◆ GeometricFieldSources() [5/7]

GeometricFieldSources ( const Internal &  ,
const HashTable< word > &   
)

Construct from types.

◆ GeometricFieldSources() [6/7]

GeometricFieldSources ( const GeometricFieldSources< Type, GeoMesh > &  )
delete

Copy constructor deleted.

as it would not set the internalField reference correctly

◆ GeometricFieldSources() [7/7]

GeometricFieldSources ( GeometricFieldSources< Type, GeoMesh > &&  )
delete

Move constructor deleted.

as it would not set the internalField reference correctly

◆ ~GeometricFieldSources()

~GeometricFieldSources

Destructor.

Definition at line 104 of file GeometricFieldSources.C.

Member Function Documentation

◆ table() [1/2]

const Foam::HashPtrTable< typename Foam::GeometricFieldSources< Type, GeoMesh >::Source > & table

Access the underlying field table.

Definition at line 116 of file GeometricFieldSources.C.

◆ table() [2/2]

Foam::HashPtrTable< typename Foam::GeometricFieldSources< Type, GeoMesh >::Source > & table

Access the underlying field table.

Definition at line 127 of file GeometricFieldSources.C.

◆ types()

Foam::HashTable< Foam::word > types

Return a map from the source name to the field source type.

Definition at line 135 of file GeometricFieldSources.C.

References forAllConstIter, HashTable< T, Key, Hash >::insert(), and Foam::type().

Here is the call graph for this function:

◆ readField()

void readField ( const Internal &  field,
const dictionary &  dict 
)

Read the sources.

Definition at line 149 of file GeometricFieldSources.C.

References clear(), dict, forAllConstIter, and Foam::compressible::New().

Here is the call graph for this function:

◆ reset()

void reset ( const GeometricFieldSources< Type, GeoMesh > &  )

Reset the boundary field contents to the given field.

Used for mesh to mesh mapping

Definition at line 174 of file GeometricFieldSources.C.

References clear(), Foam::clone(), and forAllConstIter.

Here is the call graph for this function:

◆ writeEntry()

void writeEntry ( const word &  keyword,
Ostream &  os 
) const

Write sources as dictionary entry.

Definition at line 196 of file GeometricFieldSources.C.

References token::BEGIN_BLOCK, IOstream::check(), Foam::decrIndent(), token::END_BLOCK, Foam::endl(), forAllConstIter, Foam::incrIndent(), Foam::indent(), and Foam::nl.

Referenced by GeometricField< Type, PatchField, GeoMesh >::operator/=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator[]()

const Foam::GeometricFieldSources< Type, GeoMesh >::Source & operator[] ( const word &  sourceName) const

Find and return a field source.

Definition at line 227 of file GeometricFieldSources.C.

References Foam::exit(), Foam::FatalIOError, and FatalIOErrorInFunction.

Here is the call graph for this function:
The documentation for this class was generated from the following files: