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< Type >:

[legend]

Collaboration diagram for PatchFunction1< Type >:

[legend]

Public Types
typedef Field< Type >	returnType

Public Member Functions
	TypeName ("PatchFunction1") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...

	PatchFunction1 (const polyPatch &pp, const word &entryName, const bool faceValues=true)
	Construct from polyPatch and entry name. More...

	PatchFunction1 (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true)
	Construct from polyPatch, dictionary and entry name. More...

	PatchFunction1 (const PatchFunction1< Type > &pf1)
	Copy constructor. More...

	PatchFunction1 (const PatchFunction1< Type > &pf1, const polyPatch &pp)
	Copy constructor setting patch. More...

virtual tmp< PatchFunction1< Type > >	clone () const =0
	Construct and return a clone. More...

virtual tmp< PatchFunction1< Type > >	clone (const polyPatch &pp) const =0
	Construct and return a clone setting patch. More...

virtual	~PatchFunction1 ()=default
	Destructor. More...

const word &	name () const
	Return the name of the entry. More...

virtual void	convertTimeBase (const Time &t)
	Convert time. More...

virtual tmp< Field< Type > >	value (const scalar x) const
	Return value as a function of (scalar) independent variable. More...

virtual bool	constant () const =0
	Is value constant (i.e. independent of x) More...

virtual bool	uniform () const =0
	Is value uniform (i.e. independent of coordinate) More...

virtual tmp< Field< Type > >	integrate (const scalar x1, const scalar x2) const
	Integrate between two (scalar) values. More...

virtual tmp< pointField >	localPosition (const pointField &globalPos) const
	Helper: optionally convert coordinates to local coordinates. More...

virtual tmp< Field< Type > >	transform (const Field< Type > &fld) const
	Apply optional transformation. More...

virtual tmp< Field< Type > >	transform (const tmp< Field< Type >> &tfld) const
	Apply optional transformation. More...

virtual void	autoMap (const FieldMapper &mapper)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const PatchFunction1< Type > &pf1, const labelList &addr)
	Reverse map the given PatchFunction1 onto this PatchFunction1. More...

virtual void	writeData (Ostream &os) const
	Write in dictionary format. More...

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

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 Attributes
const word	name_
	Name of entry. More...

const polyPatch &	patch_
	Reference to the patch. More...

const bool	faceValues_
	Whether to generate face or point values on patch. More...

coordinateScaling< Type >	coordSys_
	Optional local co-ordinate system and scaling. More...

Friends
Ostream &	operator (Ostream &os, const PatchFunction1< Type > &func)
	Ostream Operator. More...

Detailed Description

template<class Type>
class Foam::PatchFunction1< Type >

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 63 of file PatchFunction1.H.

Member Typedef Documentation

◆ returnType

typedef Field<Type> returnType

Definition at line 106 of file PatchFunction1.H.

Constructor & Destructor Documentation

◆ PatchFunction1() [1/4]

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

Construct from polyPatch and entry name.

◆ PatchFunction1() [2/4]

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

Construct from polyPatch, dictionary and entry name.

◆ PatchFunction1() [3/4]

PatchFunction1 ( const PatchFunction1< Type > & pf1 )

explicit

Copy constructor.

◆ PatchFunction1() [4/4]

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

explicit

Copy constructor setting patch.

◆ ~PatchFunction1()

virtual ~PatchFunction1 ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "PatchFunction1< Type >" )

Runtime type information.

Declare runtime constructor selection table

◆ clone() [1/2]

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

pure virtual

Construct and return a clone.

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

◆ clone() [2/2]

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

pure virtual

Construct and return a clone setting patch.

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

◆ New()

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

static

Selector.

Definition at line 34 of file PatchFunction1New.C.

◆ name()

const Foam::word & name ( ) const

Return the name of the entry.

Definition at line 96 of file PatchFunction1.C.

◆ convertTimeBase()

void convertTimeBase ( const Time & t )

virtual

Convert time.

Definition at line 103 of file PatchFunction1.C.

◆ value()

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

virtual

Return value as a function of (scalar) independent variable.

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

Definition at line 109 of file PatchFunction1.C.

◆ constant()

virtual bool constant ( ) const

pure virtual

Is value constant (i.e. independent of x)

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

◆ uniform()

bool uniform ( ) const

pure virtual

Is value uniform (i.e. independent of coordinate)

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

Definition at line 119 of file PatchFunction1.C.

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

Here is the caller graph for this function:

◆ integrate()

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

virtual

Integrate between two (scalar) values.

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

Definition at line 127 of file PatchFunction1.C.

◆ localPosition()

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

virtual

Helper: optionally convert coordinates to local coordinates.

Definition at line 140 of file PatchFunction1.C.

◆ transform() [1/2]

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

virtual

Apply optional transformation.

Definition at line 176 of file PatchFunction1.C.

◆ transform() [2/2]

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

virtual

Apply optional transformation.

Definition at line 153 of file PatchFunction1.C.

◆ autoMap()

void autoMap ( const FieldMapper & mapper )

virtual

Map (and resize as needed) from self given a mapping object.

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

Definition at line 197 of file PatchFunction1.C.

◆ rmap()

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

virtual

Reverse map the given PatchFunction1 onto this PatchFunction1.

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

Definition at line 203 of file PatchFunction1.C.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

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

Definition at line 211 of file PatchFunction1.C.

Friends And Related Function Documentation

◆ operator

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

friend

Ostream Operator.

Member Data Documentation

◆ name_

const word name_

protected

Name of entry.

Definition at line 92 of file PatchFunction1.H.

◆ patch_

const polyPatch& patch_

protected

Reference to the patch.

Definition at line 95 of file PatchFunction1.H.

◆ faceValues_

const bool faceValues_

protected

Whether to generate face or point values on patch.

Definition at line 98 of file PatchFunction1.H.

◆ coordSys_

coordinateScaling<Type> coordSys_

protected

Optional local co-ordinate system and scaling.

Definition at line 101 of file PatchFunction1.H.

◆ PatchFunction1

PatchFunction1

Definition at line 115 of file PatchFunction1.H.

◆ dictionary

dictionary

Definition at line 116 of file PatchFunction1.H.

◆ pp [1/2]

const polyPatch& pp

Definition at line 118 of file PatchFunction1.H.

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

◆ type [1/2]

const polyPatch const word& type

Definition at line 119 of file PatchFunction1.H.

◆ entryName [1/2]

const polyPatch const word const word& entryName

Definition at line 120 of file PatchFunction1.H.

◆ dict [1/2]

const polyPatch const word const word const dictionary& dict

Definition at line 121 of file PatchFunction1.H.

◆ faceValues

const polyPatch const word const word const dictionary const bool faceValues

Definition at line 123 of file PatchFunction1.H.

◆ pp [2/2]

const polyPatch const word const word const dictionary const bool pp

Definition at line 124 of file PatchFunction1.H.

◆ type [2/2]

const polyPatch const word const word const dictionary const bool type

Definition at line 124 of file PatchFunction1.H.

◆ entryName [2/2]

const polyPatch const word const word const dictionary const bool entryName

Definition at line 124 of file PatchFunction1.H.

◆ dict [2/2]

const polyPatch const word const word const dictionary const bool dict

Definition at line 124 of file PatchFunction1.H.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Friends

Detailed Description

template<class Type> class Foam::PatchFunction1< Type >

Member Typedef Documentation

◆ returnType

Constructor & Destructor Documentation

◆ PatchFunction1() [1/4]

◆ PatchFunction1() [2/4]

◆ PatchFunction1() [3/4]

◆ PatchFunction1() [4/4]

◆ ~PatchFunction1()

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ New()

◆ name()

◆ convertTimeBase()

◆ value()

◆ constant()

◆ uniform()

◆ integrate()

◆ localPosition()

◆ transform() [1/2]

◆ transform() [2/2]

◆ autoMap()

◆ rmap()

◆ writeData()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ name_

◆ patch_

◆ faceValues_

◆ 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]

template<class Type>
class Foam::PatchFunction1< Type >