Loading...
Searching...
No Matches
genericPatchFieldBase Class Reference

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

#include <genericPatchFieldBase.H>

Inheritance diagram for genericPatchFieldBase:
Inheritance graph
[legend]

Public Member Functions

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

Protected Member Functions

void genericFatalSolveError (const word &patchName, const IOobject &io) const
 Add error message to FatalError about solving with generic condition.
void reportMissingEntry (const word &entryName, const word &patchName, const IOobject &io) const
 FatalError for missing entry.
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.
void writeGeneric (Ostream &os, const bool separateValue) const
 Write all generic entries from dictionary, optionally treating the "value" entry separately.
template<class MapperType>
void mapGeneric (const genericPatchFieldBase &rhs, const MapperType &mapper)
 Implementation for construct with mapper.
template<class MapperType>
void autoMapGeneric (const MapperType &mapper)
 Implementation for autoMap of self given a mapping object.
void rmapGeneric (const genericPatchFieldBase &rhs, const labelList &addr)
 Implementation for reverse map given patch field onto this patch field.
 genericPatchFieldBase (const Foam::zero, const genericPatchFieldBase &)
 Partial copy construct. Only copy type and dictionary.

Detailed Description

Generic infrastructure for reading/writing unknown patch types.

Source files

Definition at line 50 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 64 of file genericPatchFieldBase.C.

References genericPatchFieldBase(), and Foam::rhs().

Referenced by genericFaePatchField< Type >::genericFaePatchField(), genericFaePatchField< Type >::genericFaePatchField(), genericFaePatchField< Type >::genericFaePatchField(), genericFaPatchField< Type >::genericFaPatchField(), genericFaPatchField< Type >::genericFaPatchField(), genericFaPatchField< Type >::genericFaPatchField(), genericFvPatchField< Type >::genericFvPatchField(), genericFvPatchField< Type >::genericFvPatchField(), genericFvPatchField< Type >::genericFvPatchField(), genericFvsPatchField< Type >::genericFvsPatchField(), genericFvsPatchField< Type >::genericFvsPatchField(), genericFvsPatchField< Type >::genericFvsPatchField(), genericPatchFieldBase(), genericPatchFieldBase(), genericPatchFieldBase(), genericPointPatchField< Type >::genericPointPatchField(), genericPointPatchField< Type >::genericPointPatchField(), genericPointPatchField< Type >::genericPointPatchField(), mapGeneric(), and rmapGeneric().

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

◆ genericPatchFieldBase() [2/5]

genericPatchFieldBase ( )
default

Default construct, generally not useful.

◆ genericPatchFieldBase() [3/5]

genericPatchFieldBase ( const genericPatchFieldBase & )
default

Copy construct.

References genericPatchFieldBase().

Here is the call graph for this function:

◆ genericPatchFieldBase() [4/5]

genericPatchFieldBase ( genericPatchFieldBase && )
default

Move construct.

References dict, and genericPatchFieldBase().

Here is the call graph for this function:

◆ genericPatchFieldBase() [5/5]

genericPatchFieldBase ( const dictionary & dict)
explicit

Initialize from dictionary.

Definition at line 54 of file genericPatchFieldBase.C.

References dict.

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 77 of file genericPatchFieldBase.C.

References Foam::FatalError, io, and Foam::nl.

Referenced by genericFaPatchField< Type >::gradientBoundaryCoeffs(), genericFvPatchField< Type >::gradientBoundaryCoeffs(), genericFvsPatchField< Type >::gradientBoundaryCoeffs(), genericFaPatchField< Type >::gradientInternalCoeffs(), genericFvPatchField< Type >::gradientInternalCoeffs(), genericFvsPatchField< Type >::gradientInternalCoeffs(), genericFaPatchField< Type >::valueBoundaryCoeffs(), genericFvPatchField< Type >::valueBoundaryCoeffs(), genericFvsPatchField< Type >::valueBoundaryCoeffs(), genericFaPatchField< Type >::valueInternalCoeffs(), genericFvPatchField< Type >::valueInternalCoeffs(), and genericFvsPatchField< Type >::valueInternalCoeffs().

Here is the caller 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 93 of file genericPatchFieldBase.C.

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

Referenced by genericFaePatchField< Type >::genericFaePatchField(), genericFaPatchField< Type >::genericFaPatchField(), genericFvPatchField< Type >::genericFvPatchField(), and genericFvsPatchField< Type >::genericFvsPatchField().

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

◆ processGeneric()

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

Definition at line 112 of file genericPatchFieldBase.C.

References io, and processEntry().

Referenced by genericFaePatchField< Type >::genericFaePatchField(), genericFaPatchField< Type >::genericFaPatchField(), genericFvPatchField< Type >::genericFvPatchField(), genericFvsPatchField< Type >::genericFvsPatchField(), and genericPointPatchField< Type >::genericPointPatchField().

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

◆ processEntry()

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

Definition at line 136 of file genericPatchFieldBase.C.

References doLocalCode, UList< T >::empty(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::flatOutput(), io, entry::isStream(), token::isWord(), entry::keyword(), VectorSpace< Form, Cmpt, Ncmpts >::nComponents, VectorSpace< Form, Cmpt, Mrows *Ncols >::nComponents, autoPtr< T >::New(), Foam::nl, Istream::putBack(), UList< T >::size(), and entry::stream().

Referenced by processGeneric().

Here is the call graph for this function:
Here is the caller 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 326 of file genericPatchFieldBase.C.

References doLocalCode, e, and os().

Referenced by writeGeneric().

Here is the call graph for this function:
Here is the caller 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 366 of file genericPatchFieldBase.C.

References os(), and putEntry().

Referenced by genericFaePatchField< Type >::write(), genericFaPatchField< Type >::write(), genericFvPatchField< Type >::write(), genericFvsPatchField< Type >::write(), and genericPointPatchField< Type >::write().

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

◆ mapGeneric()

template<class MapperType>
void mapGeneric ( const genericPatchFieldBase & rhs,
const MapperType & mapper )
protected

Implementation for construct with mapper.

Definition at line 26 of file genericPatchFieldBaseTemplates.C.

References doLocalCode, genericPatchFieldBase(), and Foam::rhs().

Referenced by genericFaePatchField< Type >::genericFaePatchField(), genericFaPatchField< Type >::genericFaPatchField(), genericFvPatchField< Type >::genericFvPatchField(), genericFvsPatchField< Type >::genericFvsPatchField(), and genericPointPatchField< Type >::genericPointPatchField().

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

◆ autoMapGeneric()

template<class MapperType>
void autoMapGeneric ( const MapperType & mapper)
protected

Implementation for autoMap of self given a mapping object.

Definition at line 54 of file genericPatchFieldBaseTemplates.C.

References doLocalCode.

Referenced by genericFaePatchField< Type >::autoMap(), genericFaPatchField< Type >::autoMap(), genericFvPatchField< Type >::autoMap(), genericFvsPatchField< Type >::autoMap(), and genericPointPatchField< Type >::autoMap().

Here is the caller graph for this function:

◆ rmapGeneric()

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

Implementation for reverse map given patch field onto this patch field.

Definition at line 390 of file genericPatchFieldBase.C.

References doLocalCode, genericPatchFieldBase(), and Foam::rhs().

Referenced by genericFaePatchField< Type >::rmap(), genericFaPatchField< Type >::rmap(), genericFvPatchField< Type >::rmap(), genericFvsPatchField< Type >::rmap(), and genericPointPatchField< Type >::rmap().

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

◆ actualType()

const word & actualType ( ) const
inlinenoexcept

The actual patch type.

Definition at line 204 of file genericPatchFieldBase.H.

References Foam::noexcept.

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