Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
genericPatchFieldBase Class Reference

Generic infrastructure for reading/writing unknown patch types. More...

Inheritance diagram for genericPatchFieldBase:
[legend]
Collaboration diagram for genericPatchFieldBase:
[legend]

Public Member Functions

 genericPatchFieldBase ()=default
 Default construct, generally not useful. More...
 
 genericPatchFieldBase (const genericPatchFieldBase &)=default
 Copy construct. More...
 
 genericPatchFieldBase (genericPatchFieldBase &&)=default
 Move construct. More...
 
 genericPatchFieldBase (const dictionary &dict)
 Initialize from dictionary. More...
 
const word & actualType () const noexcept
 The actual patch type. More...
 

Protected Member Functions

void genericFatalSolveError (const word &patchName, const IOobject &io) const
 
void reportMissingEntry (const word &entryName, const word &patchName, const IOobject &io) const
 FatalError for missing entry. More...
 
void processGeneric (const label patchSize, const word &patchName, const IOobject &io, const bool separateValue)
 
bool processEntry (const entry &dEntry, const label patchSize, const word &patchName, const IOobject &io)
 
void putEntry (const entry &e, Ostream &os) const
 Write a single entry, with lookup of hashed values. More...
 
void writeGeneric (Ostream &os, const bool separateValue) const
 
template<class MapperType >
void mapGeneric (const genericPatchFieldBase &rhs, const MapperType &mapper)
 Implementation for construct with mapper. More...
 
template<class MapperType >
void autoMapGeneric (const MapperType &mapper)
 Implementation for autoMap of self given a mapping object. More...
 
void rmapGeneric (const genericPatchFieldBase &rhs, const labelList &addr)
 
 genericPatchFieldBase (const Foam::zero, const genericPatchFieldBase &)
 Partial copy construct. Only copy type and dictionary. More...
 

Protected Attributes

word actualTypeName_
 The non-generic patch name. More...
 
dictionary dict_
 
HashPtrTable< scalarField > scalarFields_
 
HashPtrTable< vectorField > vectorFields_
 
HashPtrTable< sphericalTensorField > sphTensorFields_
 
HashPtrTable< symmTensorField > symmTensorFields_
 
HashPtrTable< tensorField > tensorFields_
 

Detailed Description

Generic infrastructure for reading/writing unknown patch types.

Source files

Definition at line 54 of file genericPatchFieldBase.H.

Constructor & Destructor Documentation

◆ genericPatchFieldBase() [1/5]

genericPatchFieldBase ( const Foam::zero  ,
const genericPatchFieldBase &  rhs 
)
protected

Partial copy construct. Only copy type and dictionary.

Definition at line 72 of file genericPatchFieldBase.C.

◆ genericPatchFieldBase() [2/5]

genericPatchFieldBase ( )
default

Default construct, generally not useful.

◆ genericPatchFieldBase() [3/5]

genericPatchFieldBase ( const genericPatchFieldBase &  )
default

Copy construct.

◆ genericPatchFieldBase() [4/5]

genericPatchFieldBase ( genericPatchFieldBase &&  )
default

Move construct.

◆ genericPatchFieldBase() [5/5]

genericPatchFieldBase ( const dictionary &  dict)
explicit

Initialize from dictionary.

Definition at line 62 of file genericPatchFieldBase.C.

Member Function Documentation

◆ genericFatalSolveError()

void genericFatalSolveError ( const word &  patchName,
const IOobject &  io 
) const
protected

Add error message to FatalError about solving with generic condition

Definition at line 85 of file genericPatchFieldBase.C.

References Foam::FatalError, IOobject::name(), Foam::nl, and IOobject::objectPath().

Here is the call graph for this function:

◆ reportMissingEntry()

void reportMissingEntry ( const word &  entryName,
const word &  patchName,
const IOobject &  io 
) const
protected

FatalError for missing entry.

Definition at line 101 of file genericPatchFieldBase.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOobject::name(), Foam::nl, and IOobject::objectPath().

Here is the call graph for this function:

◆ processGeneric()

void processGeneric ( const label  patchSize,
const word &  patchName,
const IOobject &  io,
const bool  separateValue 
)
protected

Definition at line 120 of file genericPatchFieldBase.C.

References Foam::glTF::key().

Here is the call graph for this function:

◆ processEntry()

bool processEntry ( const entry &  dEntry,
const label  patchSize,
const word &  patchName,
const IOobject &  io 
)
protected

Definition at line 144 of file genericPatchFieldBase.C.

References Foam::dynamicCast(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FIELDSIZE_CHECK, Foam::flatOutput(), entry::isStream(), token::isWord(), Foam::glTF::key(), entry::keyword(), IOobject::name(), VectorSpace< SphericalTensor< scalar >, scalar, 1 >::nComponents, VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, VectorSpace< SymmTensor< scalar >, scalar, 6 >::nComponents, autoPtr< T >::New(), Foam::nl, IOobject::objectPath(), Istream::putBack(), and entry::stream().

Here is the call graph for this function:

◆ putEntry()

void putEntry ( const entry &  e,
Ostream &  os 
) const
protected

Write a single entry, with lookup of hashed values.

Definition at line 423 of file genericPatchFieldBase.C.

References Foam::constant::electromagnetic::e, Foam::glTF::key(), and os().

Here is the call graph for this function:

◆ writeGeneric()

void writeGeneric ( Ostream &  os,
const bool  separateValue 
) const
protected

Write all generic entries from dictionary, optionally treating the "value" entry separately

Definition at line 466 of file genericPatchFieldBase.C.

References Foam::glTF::key(), entry::keyword(), os(), and Ostream::writeEntry().

Here is the call graph for this function:

◆ mapGeneric()

void mapGeneric ( const genericPatchFieldBase &  rhs,
const MapperType &  mapper 
)
protected

Implementation for construct with mapper.

Definition at line 34 of file genericPatchFieldBaseTemplates.C.

References forAllConstIters(), Foam::New(), genericPatchFieldBase::scalarFields_, genericPatchFieldBase::sphTensorFields_, genericPatchFieldBase::symmTensorFields_, genericPatchFieldBase::tensorFields_, and genericPatchFieldBase::vectorFields_.

Here is the call graph for this function:

◆ autoMapGeneric()

void autoMapGeneric ( const MapperType &  mapper)
protected

Implementation for autoMap of self given a mapping object.

Definition at line 88 of file genericPatchFieldBaseTemplates.C.

References forAllIters.

◆ rmapGeneric()

void rmapGeneric ( const genericPatchFieldBase &  rhs,
const labelList &  addr 
)
protected

Implementation for reverse map given patch field onto this patch field

Definition at line 490 of file genericPatchFieldBase.C.

References forAllIters, genericPatchFieldBase::scalarFields_, genericPatchFieldBase::sphTensorFields_, genericPatchFieldBase::symmTensorFields_, genericPatchFieldBase::tensorFields_, and genericPatchFieldBase::vectorFields_.

◆ actualType()

const word& actualType ( ) const
inlinenoexcept

The actual patch type.

Definition at line 172 of file genericPatchFieldBase.H.

References genericPatchFieldBase::actualTypeName_.

Member Data Documentation

◆ actualTypeName_

word actualTypeName_
protected

The non-generic patch name.

Definition at line 73 of file genericPatchFieldBase.H.

Referenced by genericPatchFieldBase::actualType().

◆ dict_

dictionary dict_
protected

Definition at line 75 of file genericPatchFieldBase.H.

◆ scalarFields_

HashPtrTable<scalarField> scalarFields_
protected

Definition at line 77 of file genericPatchFieldBase.H.

Referenced by genericPatchFieldBase::mapGeneric(), and genericPatchFieldBase::rmapGeneric().

◆ vectorFields_

HashPtrTable<vectorField> vectorFields_
protected

Definition at line 78 of file genericPatchFieldBase.H.

Referenced by genericPatchFieldBase::mapGeneric(), and genericPatchFieldBase::rmapGeneric().

◆ sphTensorFields_

HashPtrTable<sphericalTensorField> sphTensorFields_
protected

Definition at line 79 of file genericPatchFieldBase.H.

Referenced by genericPatchFieldBase::mapGeneric(), and genericPatchFieldBase::rmapGeneric().

◆ symmTensorFields_

HashPtrTable<symmTensorField> symmTensorFields_
protected

Definition at line 80 of file genericPatchFieldBase.H.

Referenced by genericPatchFieldBase::mapGeneric(), and genericPatchFieldBase::rmapGeneric().

◆ tensorFields_

HashPtrTable<tensorField> tensorFields_
protected

Definition at line 81 of file genericPatchFieldBase.H.

Referenced by genericPatchFieldBase::mapGeneric(), and genericPatchFieldBase::rmapGeneric().

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