Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or time varying, and provide functions to return the (interpolated) value, and integral between limits. More...

Inheritance diagram for PatchFunction1:

[legend]

Collaboration diagram for PatchFunction1:

[legend]

Public Types
typedef Field< Type >	returnType

Public Member Functions
	TypeName ("PatchFunction1") declareRunTimeSelectionTable(autoPtr

	PatchFunction1 (const polyPatch &pp, const word &entryName, const bool faceValues=true)

	PatchFunction1 (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true)

	PatchFunction1 (const PatchFunction1< Type > &rhs)

	PatchFunction1 (const PatchFunction1< Type > &rhs, const polyPatch &pp)

virtual tmp< PatchFunction1< Type > >	clone () const =0

virtual tmp< PatchFunction1< Type > >	clone (const polyPatch &pp) const =0

virtual	~PatchFunction1 ()=default

virtual bool	constant () const

virtual bool	uniform () const =0

virtual tmp< Field< Type > >	value (const scalar x) const

virtual tmp< Field< Type > >	integrate (const scalar x1, const scalar x2) const

virtual tmp< pointField >	localPosition (const pointField &globalPos) const

virtual tmp< Field< Type > >	transform (const Field< Type > &fld) const

virtual tmp< Field< Type > >	transform (const tmp< Field< Type >> &tfld) const

virtual void	autoMap (const FieldMapper &mapper)

virtual void	rmap (const PatchFunction1< Type > &rhs, const labelList &addr)

virtual void	writeData (Ostream &os) const

Static Public Member Functions
static autoPtr< PatchFunction1< Type > >	New (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true, const bool mandatory=true)

static autoPtr< PatchFunction1< Type > >	NewCompat (const polyPatch &pp, const word &entryName, std::initializer_list< std::pair< const char *, int >> compat, const dictionary &dict, const bool faceValues=true, const bool mandatory=true)

static autoPtr< PatchFunction1< Type > >	NewIfPresent (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true)

static refPtr< PatchFunction1< Type > >	New (HashPtrTable< PatchFunction1< Type >> &cache, const polyPatch &pp, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const bool faceValues=true, const bool mandatory=true)

Public Attributes
	PatchFunction1

	dictionary

const polyPatch &	pp

const polyPatch const word &	type

const polyPatch const word const word &	entryName

const polyPatch const word const word const dictionary &	dict

const polyPatch const word const word const dictionary const bool	faceValues

const polyPatch const word const word const dictionary const bool	pp

const polyPatch const word const word const dictionary const bool	type

const polyPatch const word const word const dictionary const bool	entryName

const polyPatch const word const word const dictionary const bool	dict

Protected Member Functions
void	operator= (const PatchFunction1< Type > &)=delete

Protected Attributes
coordinateScaling< Type >	coordSys_

Friends
Ostream &	operator (Ostream &os, const PatchFunction1< Type > &rhs)

Detailed Description

Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or time varying, and provide functions to return the (interpolated) value, and integral between limits.

Extends the Function1 class by adding autoMap and rMap functions

Source files

See also: Foam::Function1

Definition at line 56 of file PatchFunction1.H.

Member Typedef Documentation

◆ returnType

typedef Field<Type> returnType

Definition at line 100 of file PatchFunction1.H.

Constructor & Destructor Documentation

◆ PatchFunction1() [1/4]

PatchFunction1	(	const polyPatch &	pp,
		const word &	entryName,
		const bool	faceValues = `true`
	)

◆ PatchFunction1() [2/4]

PatchFunction1	(	const polyPatch &	pp,
		const word &	entryName,
		const dictionary &	dict,
		const bool	faceValues = `true`
	)

◆ PatchFunction1() [3/4]

PatchFunction1 ( const PatchFunction1< Type > & rhs )

explicit

Definition at line 55 of file PatchFunction1.C.

◆ PatchFunction1() [4/4]

PatchFunction1	(	const PatchFunction1< Type > &	rhs,
		const polyPatch &	pp
	)

explicit

Definition at line 63 of file PatchFunction1.C.

◆ ~PatchFunction1()

virtual ~PatchFunction1 ( )

virtualdefault

Member Function Documentation

◆ operator=()

void operator= ( const PatchFunction1< Type > & )

protecteddelete

◆ TypeName()

TypeName ( "PatchFunction1" )

◆ clone() [1/2]

virtual tmp<PatchFunction1<Type> > clone ( ) const

pure virtual

◆ clone() [2/2]

virtual tmp<PatchFunction1<Type> > clone ( const polyPatch & pp ) const

pure virtual

Implemented in MappedFile< Type >, CodedField< Type >, Sampled< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.

◆ New() [1/2]

static autoPtr<PatchFunction1<Type> > New	(	const polyPatch &	pp,
		const word &	entryName,
		const dictionary &	dict,
		const bool	faceValues = `true`,
		const bool	mandatory = `true`
	)

static

◆ NewCompat()

Foam::autoPtr< Foam::PatchFunction1< Type > > NewCompat	(	const polyPatch &	pp,
		const word &	entryName,
		std::initializer_list< std::pair< const char *, int >>	compat,
		const dictionary &	dict,
		const bool	faceValues = `true`,
		const bool	mandatory = `true`
	)

static

Definition at line 183 of file PatchFunction1New.C.

◆ NewIfPresent()

Foam::autoPtr< Foam::PatchFunction1< Type > > NewIfPresent	(	const polyPatch &	pp,
		const word &	entryName,
		const dictionary &	dict,
		const bool	faceValues = `true`
	)

static

Definition at line 207 of file PatchFunction1New.C.

Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), and turbulentTemperatureRadCoupledMixedFvPatchScalarField::turbulentTemperatureRadCoupledMixedFvPatchScalarField().

Here is the caller graph for this function:

◆ New() [2/2]

static refPtr<PatchFunction1<Type> > New	(	HashPtrTable< PatchFunction1< Type >> &	cache,
		const polyPatch &	pp,
		const word &	entryName,
		const dictionary &	dict,
		enum keyType::option	matchOpt = `keyType::LITERAL`,
		const bool	faceValues = `true`,
		const bool	mandatory = `true`
	)

static

◆ constant()

virtual bool constant ( ) const

inlinevirtual

Definition at line 214 of file PatchFunction1.H.

◆ uniform()

bool uniform ( ) const

pure virtual

Definition at line 76 of file PatchFunction1.C.

Referenced by UniformValueField< Type >::uniform(), ConstantField< Type >::uniform(), and MappedFile< Type >::uniform().

Here is the caller graph for this function:

◆ value()

Foam::tmp< Foam::Field< Type > > value ( const scalar x ) const

virtual

Reimplemented in MappedFile< Type >, CodedField< Type >, Sampled< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.

Definition at line 84 of file PatchFunction1.C.

◆ integrate()

Foam::tmp< Foam::Field< Type > > integrate	(	const scalar	x1,
		const scalar	x2
	)		const

virtual

Reimplemented in MappedFile< Type >, Sampled< Type >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.

Definition at line 95 of file PatchFunction1.C.

◆ localPosition()

Foam::tmp< Foam::pointField > localPosition ( const pointField & globalPos ) const

virtual

Definition at line 107 of file PatchFunction1.C.

◆ transform() [1/2]

Foam::tmp< Foam::Field< Type > > transform ( const Field< Type > & fld ) const

virtual

Definition at line 143 of file PatchFunction1.C.

◆ transform() [2/2]

Foam::tmp< Foam::Field< Type > > transform ( const tmp< Field< Type >> & tfld ) const

virtual

Definition at line 120 of file PatchFunction1.C.

◆ autoMap()

void autoMap ( const FieldMapper & mapper )

virtual

Reimplemented in MappedFile< Type >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.

Definition at line 164 of file PatchFunction1.C.

◆ rmap()

void rmap	(	const PatchFunction1< Type > &	rhs,
		const labelList &	addr
	)

virtual

Reimplemented in MappedFile< Type >, CodedField< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.

Definition at line 170 of file PatchFunction1.C.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Reimplemented in MappedFile< Type >, CodedField< Type >, Sampled< Type >, ConstantField< Type >, PatchExprField< Type >, and UniformValueField< Type >.

Definition at line 178 of file PatchFunction1.C.

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	os,
		const PatchFunction1< Type > &	rhs
	)

friend

Member Data Documentation

◆ coordSys_

coordinateScaling<Type> coordSys_

protected

Definition at line 89 of file PatchFunction1.H.

◆ PatchFunction1

PatchFunction1

Definition at line 109 of file PatchFunction1.H.

◆ dictionary

dictionary

Definition at line 110 of file PatchFunction1.H.

◆ pp [1/2]

const polyPatch& pp

Definition at line 112 of file PatchFunction1.H.

◆ type [1/2]

const polyPatch const word& type

Definition at line 113 of file PatchFunction1.H.

◆ entryName [1/2]

const polyPatch const word const word& entryName

Definition at line 114 of file PatchFunction1.H.

◆ dict [1/2]

const polyPatch const word const word const dictionary& dict

Definition at line 115 of file PatchFunction1.H.

◆ faceValues

const polyPatch const word const word const dictionary const bool faceValues

Definition at line 117 of file PatchFunction1.H.

◆ pp [2/2]

const polyPatch const word const word const dictionary const bool pp

Definition at line 118 of file PatchFunction1.H.

◆ type [2/2]

const polyPatch const word const word const dictionary const bool type

Definition at line 118 of file PatchFunction1.H.

◆ entryName [2/2]

const polyPatch const word const word const dictionary const bool entryName

Definition at line 118 of file PatchFunction1.H.

◆ dict [2/2]

const polyPatch const word const word const dictionary const bool dict

Definition at line 118 of file PatchFunction1.H.

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

src/meshTools/PatchFunction1/PatchFunction1/PatchFunction1.H
src/meshTools/PatchFunction1/PatchFunction1/PatchFunction1.C
src/meshTools/PatchFunction1/PatchFunction1/PatchFunction1New.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ returnType

Constructor & Destructor Documentation

◆ PatchFunction1() [1/4]

◆ PatchFunction1() [2/4]

◆ PatchFunction1() [3/4]

◆ PatchFunction1() [4/4]

◆ ~PatchFunction1()

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ New() [1/2]

◆ NewCompat()

◆ NewIfPresent()

◆ New() [2/2]

◆ constant()

◆ uniform()

◆ value()

◆ integrate()

◆ localPosition()

◆ transform() [1/2]

◆ transform() [2/2]

◆ autoMap()

◆ rmap()

◆ writeData()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ coordSys_

◆ PatchFunction1

◆ dictionary

◆ pp [1/2]

◆ type [1/2]

◆ entryName [1/2]

◆ dict [1/2]

◆ faceValues

◆ pp [2/2]

◆ type [2/2]

◆ entryName [2/2]

◆ dict [2/2]