Templated function that returns a constant value. More...

Inheritance diagram for ConstantField< Type >:

Collaboration diagram for ConstantField< Type >:

Public Member Functions
	TypeName ("constant")

	ConstantField (const polyPatch &pp, const word &entryName, const bool isUniform, const Type &uniformValue, const Field< Type > &nonUniformValue, const dictionary &dict=dictionary::null, const bool faceValues=true)
	Construct from components. More...

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

	ConstantField (const ConstantField< Type > &cnst)
	Copy constructor. More...

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

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

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

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

virtual tmp< Field< Type > >	value (const scalar x) const
	Return constant value. More...

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

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

virtual tmp< Field< Type > >	integrate (const scalar x1, const scalar x2) const
	Integrate between two values. 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...

Public Member Functions inherited from PatchFunction1< Type >
	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	~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< 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...

Additional Inherited Members
Public Types inherited from PatchFunction1< Type >
typedef Field< Type >	returnType

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

Public Attributes inherited from PatchFunction1< Type >
	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 inherited from PatchFunction1< Type >
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...

Detailed Description

template<class Type>
class Foam::PatchFunction1Types::ConstantField< Type >

Templated function that returns a constant value.

Usage - for entry <entryName> returning the value

:

    <entryName>    constant  <value>

Source files

Definition at line 58 of file ConstantField.H.

Constructor & Destructor Documentation

◆ ConstantField() [1/4]

ConstantField	(	const polyPatch &	pp,
		const word &	entryName,
		const bool	isUniform,
		const Type &	uniformValue,
		const Field< Type > &	nonUniformValue,
		const dictionary &	dict = `dictionary::null`,
		const bool	faceValues = `true`
	)

Construct from components.

Definition at line 34 of file ConstantField.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, patchIdentifier::name(), and PrimitivePatch< Face, FaceList, PointField, PointType >::nPoints().

Here is the call graph for this function:

◆ ConstantField() [2/4]

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

Construct from entry name and dictionary.

Definition at line 159 of file ConstantField.C.

◆ ConstantField() [3/4]

ConstantField ( const ConstantField< Type > & cnst )

explicit

Copy constructor.

Definition at line 184 of file ConstantField.C.

◆ ConstantField() [4/4]

ConstantField	(	const ConstantField< Type > &	cnst,
		const polyPatch &	pp
	)

explicit

Copy constructor setting patch.

Definition at line 197 of file ConstantField.C.

◆ ~ConstantField()

virtual ~ConstantField ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "constant" )

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Implements PatchFunction1< Type >.

Definition at line 131 of file ConstantField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting patch.

Implements PatchFunction1< Type >.

Definition at line 137 of file ConstantField.H.

References PatchFunction1< Type >::pp.

◆ value()

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

inlinevirtual

Return constant value.

Reimplemented from PatchFunction1< Type >.

Definition at line 35 of file ConstantFieldI.H.

References Foam::transform().

Here is the call graph for this function:

◆ constant()

virtual bool constant ( ) const

inlinevirtual

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

Implements PatchFunction1< Type >.

Definition at line 158 of file ConstantField.H.

◆ uniform()

virtual bool uniform ( ) const

inlinevirtual

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

Implements PatchFunction1< Type >.

Definition at line 164 of file ConstantField.H.

References PatchFunction1< Type >::uniform().

Here is the call graph for this function:

◆ integrate()

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

inlinevirtual

Integrate between two values.

Reimplemented from PatchFunction1< Type >.

Definition at line 53 of file ConstantFieldI.H.

References Foam::transform().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const FieldMapper & mapper )

virtual

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

Reimplemented from PatchFunction1< Type >.

Definition at line 225 of file ConstantField.C.

◆ rmap()

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

virtual

Reverse map the given PatchFunction1 onto this PatchFunction1.

Reimplemented from PatchFunction1< Type >.

Definition at line 241 of file ConstantField.C.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from PatchFunction1< Type >.

Definition at line 253 of file ConstantField.C.

References Foam::nl, writeData(), and Ostream::writeKeyword().

Here is the call graph for this function:

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

src/meshTools/PatchFunction1/ConstantField/ConstantField.H
src/meshTools/PatchFunction1/ConstantField/ConstantField.C
src/meshTools/PatchFunction1/ConstantField/ConstantFieldI.H

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::PatchFunction1Types::ConstantField< Type >

Constructor & Destructor Documentation

◆ ConstantField() [1/4]

◆ ConstantField() [2/4]

◆ ConstantField() [3/4]

◆ ConstantField() [4/4]

◆ ~ConstantField()

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ value()

◆ constant()

◆ uniform()

◆ integrate()

◆ autoMap()

◆ rmap()

◆ writeData()

template<class Type>
class Foam::PatchFunction1Types::ConstantField< Type >