Patch value mapping from file. More...

Inheritance diagram for MappedFile< Type >:

Collaboration diagram for MappedFile< Type >:

Public Member Functions
	TypeName ("mappedFile")
	Runtime type information. More...

void	operator= (const MappedFile< Type > &)=delete
	No copy assignment. More...

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

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

	MappedFile (const MappedFile< Type > &rhs)
	Copy construct. More...

	MappedFile (const MappedFile< Type > &rhs, const polyPatch &pp)
	Copy construct 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	~MappedFile ()=default
	Destructor. More...

virtual tmp< Field< Type > >	value (const scalar) const
	Return MappedFile 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 > &rhs)
	Copy construct. More...

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

virtual	~PatchFunction1 ()=default
	Destructor. 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, const bool mandatory=true)
	Selector. More...

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)
	Compatibility selector. More...

static autoPtr< PatchFunction1< Type > >	NewIfPresent (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true)
	An optional 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 Member Functions inherited from PatchFunction1< Type >
void	operator= (const PatchFunction1< Type > &)=delete
	No copy assignment. More...

Protected Attributes inherited from PatchFunction1< Type >
coordinateScaling< Type >	coordSys_
	Optional local co-ordinate system and scaling. More...

Detailed Description

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

Patch value mapping from file.

Options:

Property	Description	Required	Default
`mapMethod`	(nearest/planarInterpolation)	no	planarInterpolation
`offset`	Time-varying offset values to interpolated data	no
`fieldTable`	Name of field data table	no	field-name
`points`	The name of the points file	no	points
`perturb`	Perturbation fraction of bounding box	no	1e-5
`setAverage`	adjust mapped field to maintain average value	no	false

Source files

Definition at line 101 of file MappedFile.H.

Constructor & Destructor Documentation

◆ MappedFile() [1/4]

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

Construct from entry name and dictionary.

Definition at line 35 of file MappedFile.C.

◆ MappedFile() [2/4]

MappedFile	(	const polyPatch &	pp,
		const word &	entryName,
		const dictionary &	dict,
		const word &	fieldTableName,
		const bool	faceValues
	)

Construct from entry name and dictionary.

Definition at line 84 of file MappedFile.C.

◆ MappedFile() [3/4]

MappedFile ( const MappedFile< Type > & rhs )

explicit

Copy construct.

Definition at line 131 of file MappedFile.C.

◆ MappedFile() [4/4]

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

explicit

Copy construct setting patch.

Definition at line 141 of file MappedFile.C.

◆ ~MappedFile()

virtual ~MappedFile ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedFile" )

Runtime type information.

◆ operator=()

void operator= ( const MappedFile< Type > & )

delete

No copy assignment.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Implements PatchFunction1< Type >.

Definition at line 202 of file MappedFile.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 211 of file MappedFile.H.

◆ value()

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

virtual

Return MappedFile value.

Reimplemented from PatchFunction1< Type >.

Definition at line 466 of file MappedFile.C.

◆ constant()

virtual bool constant ( ) const

inlinevirtual

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

Implements PatchFunction1< Type >.

Definition at line 232 of file MappedFile.H.

◆ uniform()

virtual bool uniform ( ) const

inlinevirtual

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

Implements PatchFunction1< Type >.

Definition at line 238 of file MappedFile.H.

◆ integrate()

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

virtual

Integrate between two values.

Reimplemented from PatchFunction1< Type >.

Definition at line 576 of file MappedFile.C.

◆ 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 169 of file MappedFile.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 189 of file MappedFile.C.

Referenced by MappedFile< scalar >::rmap().

Here is the caller graph for this function:

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from PatchFunction1< Type >.

Definition at line 588 of file MappedFile.C.

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

src/meshTools/PatchFunction1/MappedFile/MappedFile.H
src/meshTools/PatchFunction1/MappedFile/MappedFile.C

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ MappedFile() [1/4]

◆ MappedFile() [2/4]

◆ MappedFile() [3/4]

◆ MappedFile() [4/4]

◆ ~MappedFile()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ clone() [1/2]

◆ clone() [2/2]

◆ value()

◆ constant()

◆ uniform()

◆ integrate()

◆ autoMap()

◆ rmap()

◆ writeData()

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