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

Inheritance 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
	Add error message to FatalError about solving with generic condition. More...

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
	Write all generic entries from dictionary, optionally treating the "value" entry separately. More...

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)
	Implementation for reverse map given patch field onto this patch field. More...

	genericPatchFieldBase (const Foam::zero, const genericPatchFieldBase &)
	Partial copy construct. Only copy type and dictionary. More...

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 65 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 55 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 78 of file genericPatchFieldBase.C.

References Foam::FatalError, io(), 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 94 of file genericPatchFieldBase.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, io(), 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 113 of file genericPatchFieldBase.C.

References io(), and 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 137 of file genericPatchFieldBase.C.

References doLocalCode, UList< T >::empty(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::flatOutput(), io(), entry::isStream(), token::isWord(), Foam::glTF::key(), entry::keyword(), IOobject::name(), VectorSpace< SphericalTensor< scalar >, scalar, 1 >::nComponents, VectorSpace< Form, Cmpt, Ncmpts >::nComponents, Foam::expressions::Detail::nComponents(), Foam::nl, IOobject::objectPath(), Istream::putBack(), UList< T >::size(), 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 327 of file genericPatchFieldBase.C.

References doLocalCode, 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 367 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 27 of file genericPatchFieldBaseTemplates.C.

References doLocalCode.

◆ autoMapGeneric()

void autoMapGeneric ( const MapperType & mapper )

protected

Implementation for autoMap of self given a mapping object.

Definition at line 55 of file genericPatchFieldBaseTemplates.C.

References doLocalCode.

◆ rmapGeneric()

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

protected

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

Definition at line 391 of file genericPatchFieldBase.C.

References doLocalCode.

◆ actualType()

const word& actualType ( ) const

inlinenoexcept

The actual patch type.

Definition at line 204 of file genericPatchFieldBase.H.

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

src/genericPatchFields/common/genericPatchFieldBase.H
src/genericPatchFields/common/genericPatchFieldBase.C
src/genericPatchFields/common/genericPatchFieldBaseTemplates.C

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ genericPatchFieldBase() [1/5]

◆ genericPatchFieldBase() [2/5]

◆ genericPatchFieldBase() [3/5]

◆ genericPatchFieldBase() [4/5]

◆ genericPatchFieldBase() [5/5]

Member Function Documentation

◆ genericFatalSolveError()

◆ reportMissingEntry()

◆ processGeneric()

◆ processEntry()

◆ putEntry()

◆ writeGeneric()

◆ mapGeneric()

◆ autoMapGeneric()

◆ rmapGeneric()

◆ actualType()