GeometricFieldSources< Type, GeoMesh, PrimitiveField > Class Template Reference

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

Inheritance diagram for GeometricFieldSources< Type, GeoMesh, PrimitiveField >:

Collaboration diagram for GeometricFieldSources< Type, GeoMesh, PrimitiveField >:

Public Types
typedef DimensionedField< Type, GeoMesh, PrimitiveField >	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...
template<template< class > class PrimitiveField2>
	GeometricFieldSources (const Internal &, const GeometricFieldSources< Type, GeoMesh, PrimitiveField2 > &)
	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 Internal &, 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...
template<class Type , class GeoMesh , template< class > class PrimitiveField>
	GeometricFieldSources (const DimensionedField< Type, GeoMesh, PrimitiveField > &iF, const HashPtrTable< Source > &mtf)
template<class Type , class GeoMesh , template< class > class PrimitiveField>
	GeometricFieldSources (const DimensionedField< Type, GeoMesh, PrimitiveField > &iF, const GeometricFieldSources< Type, GeoMesh, PrimitiveField > &mtf)
template<template< class > class PrimitiveField2>
	GeometricFieldSources (const DimensionedField< Type, GeoMesh, PrimitiveField > &iF, const GeometricFieldSources< Type, GeoMesh, PrimitiveField2 > &mtf)
template<class Type , class GeoMesh , template< class > class PrimitiveField>
	GeometricFieldSources (const DimensionedField< Type, GeoMesh, PrimitiveField > &iF, const dictionary &dict)
template<class Type , class GeoMesh , template< class > class PrimitiveField>
	GeometricFieldSources (const DimensionedField< Type, GeoMesh, PrimitiveField > &iF, const HashTable< word > &types)

Friends
template<class Type2 , class GeoMesh2 , template< class > class PrimitiveField2>
class	GeometricFieldSources
	Declare friendship with other geometric field sources. More...

Detailed Description

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

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

Source files

• GeometricFieldSources.H
• GeometricFieldSources.C

Definition at line 54 of file GeometricFieldSources.H.

Member Typedef Documentation

Internal

typedef DimensionedField<Type, GeoMesh, PrimitiveField> 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/13]

GeometricFieldSources

Construct null.

Definition at line 31 of file GeometricFieldSources.C.

GeometricFieldSources() [2/13]

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

Construct from a table of field sources.

GeometricFieldSources() [3/13]

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

Construct as copy setting the reference to the internal field.

GeometricFieldSources() [4/13]

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

explicit

Construct as copy setting the reference to the internal field.

GeometricFieldSources() [5/13]

GeometricFieldSources	(	const Internal &	,
		const dictionary &
	)

Construct from dictionary.

GeometricFieldSources() [6/13]

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

Construct from types.

GeometricFieldSources() [7/13]

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

delete

Copy constructor deleted.

as it would not set the internalField reference correctly

GeometricFieldSources() [8/13]

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

delete

Move constructor deleted.

as it would not set the internalField reference correctly

~GeometricFieldSources()

~GeometricFieldSources

Destructor.

Definition at line 122 of file GeometricFieldSources.C.

GeometricFieldSources() [9/13]

GeometricFieldSources	(	const DimensionedField< Type, GeoMesh, PrimitiveField > &	iF,
		const HashPtrTable< Source > &	mtf
	)

Definition at line 40 of file GeometricFieldSources.C.

References Foam::clone(), and forAllConstIter.

Here is the call graph for this function:

GeometricFieldSources() [10/13]

GeometricFieldSources	(	const DimensionedField< Type, GeoMesh, PrimitiveField > &	iF,
		const GeometricFieldSources< Type, GeoMesh, PrimitiveField > &	mtf
	)

Definition at line 58 of file GeometricFieldSources.C.

GeometricFieldSources() [11/13]

GeometricFieldSources	(	const DimensionedField< Type, GeoMesh, PrimitiveField > &	iF,
		const GeometricFieldSources< Type, GeoMesh, PrimitiveField2 > &	mtf
	)

Definition at line 71 of file GeometricFieldSources.C.

GeometricFieldSources() [12/13]

GeometricFieldSources	(	const DimensionedField< Type, GeoMesh, PrimitiveField > &	iF,
		const dictionary &	dict
	)

Definition at line 83 of file GeometricFieldSources.C.

References dict, and GeometricFieldSources< Type, GeoMesh, PrimitiveField >::readField().

Here is the call graph for this function:

GeometricFieldSources() [13/13]

GeometricFieldSources	(	const DimensionedField< Type, GeoMesh, PrimitiveField > &	iF,
		const HashTable< word > &	types
	)

Definition at line 98 of file GeometricFieldSources.C.

References forAllConstIter, Foam::compressible::New(), and GeometricFieldSources< Type, GeoMesh, PrimitiveField >::types().

Here is the call graph for this function:

Member Function Documentation

table() [1/2]

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

Access the underlying field table.

Definition at line 134 of file GeometricFieldSources.C.

Referenced by fvFieldDecomposer::decomposeVolField().

Here is the caller graph for this function:

table() [2/2]

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

Access the underlying field table.

Definition at line 145 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 153 of file GeometricFieldSources.C.

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

Referenced by GeometricFieldSources< Type, GeoMesh, PrimitiveField >::GeometricFieldSources().

Here is the call graph for this function:

Here is the caller graph for this function:

readField()

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

Read the sources.

Definition at line 167 of file GeometricFieldSources.C.

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

Referenced by GeometricFieldSources< Type, GeoMesh, PrimitiveField >::GeometricFieldSources().

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

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

Reset the boundary field contents to the given field.

Used for mesh to mesh mapping

Definition at line 192 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 210 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, GeoMesh, PrimitiveField >::operator/=().

Here is the call graph for this function:

Here is the caller graph for this function:

operator[]()

const Foam::GeometricFieldSources< Type, GeoMesh, PrimitiveField >::Source & operator[]

(

const word &

sourceName

)

const

Find and return a field source.

Definition at line 242 of file GeometricFieldSources.C.

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

Here is the call graph for this function:

Friends And Related Function Documentation

GeometricFieldSources

friend class GeometricFieldSources

friend

Declare friendship with other geometric field sources.

Definition at line 81 of file GeometricFieldSources.H.

---

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

• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricFieldFwd.H
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricFieldSources.H
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricFieldSources.C