This function object linearly interpolates volume fields to generate surface fields. More...

Collaboration diagram for surfaceInterpolateFields:

[legend]

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

	surfaceInterpolateFields (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
	Construct for given objectRegistry and dictionary. More...

virtual	~surfaceInterpolateFields ()
	Destructor. More...

virtual const word &	name () const
	Return name of the surfaceInterpolateFields object. More...

virtual void	read (const dictionary &)
	Read the field min/max data. More...

virtual void	execute ()
	Execute, currently does nothing. More...

virtual void	end ()
	Execute at the final time-loop, currently does nothing. More...

virtual void	timeSet ()
	Called when time was set at the end of the Time::operator++. More...

virtual void	write ()
	Write. More...

virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &)
	Update for changes of mesh. More...

Protected Member Functions
	surfaceInterpolateFields (const surfaceInterpolateFields &)
	Disallow default bitwise copy construct. More...

void	operator= (const surfaceInterpolateFields &)
	Disallow default bitwise assignment. More...

template<class Type >
void	interpolateFields (PtrList< GeometricField< Type, fvsPatchField, surfaceMesh > > &) const

Protected Attributes
word	name_
	Name of this set of surfaceInterpolateFields object. More...

const objectRegistry &	obr_

bool	active_
	on/off switch More...

List< Tuple2< word, word > >	fieldSet_
	Fields to process. More...

Switch	log_
	Switch to send output to Info as well as to file. More...

PtrList< surfaceScalarField >	ssf_
	Locally constructed fields. More...

PtrList< surfaceVectorField >	svf_

PtrList< surfaceSphericalTensorField >	sSpheretf_

PtrList< surfaceSymmTensorField >	sSymmtf_

PtrList< surfaceTensorField >	stf_

Detailed Description

This function object linearly interpolates volume fields to generate surface fields.

Group grpFieldFunctionObjects

Fields are stored

every time step the field is updated with new values
at output it writes the fields

This functionObject can either be used

to calculate a new field as a post-processing step or
since the fields are registered, used in another functionObject

Example of function object specification:

surfaceInterpolateFields1
{
    type        surfaceInterpolateFields;
    functionObjectLibs ("libfieldFunctionObjects.so");
    ...
    fields      ((p pNear)(U UNear));
}

Function object usage

Property	Description	Required	Default value
`type`	type name: nearWallFields	yes
`fields`	list of fields with correspoding output field names	yes
`log`	Log to standard output	no	yes

See also: Foam::functionObject Foam::OutputFilterFunctionObject

Source files

Definition at line 111 of file surfaceInterpolateFields.H.

Constructor & Destructor Documentation

◆ surfaceInterpolateFields() [1/2]

surfaceInterpolateFields ( const surfaceInterpolateFields & )

protected

Disallow default bitwise copy construct.

◆ surfaceInterpolateFields() [2/2]

surfaceInterpolateFields	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	loadFromFiles = `false`
	)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 39 of file surfaceInterpolateFields.C.

References dict, Foam::endl(), Foam::read(), and WarningInFunction.

Here is the call graph for this function:

◆ ~surfaceInterpolateFields()

~surfaceInterpolateFields ( )

virtual

Destructor.

Definition at line 69 of file surfaceInterpolateFields.C.

Member Function Documentation

◆ operator=()

void operator= ( const surfaceInterpolateFields & )

protected

Disallow default bitwise assignment.

◆ interpolateFields()

void interpolateFields ( PtrList< GeometricField< Type, fvsPatchField, surfaceMesh > > & sflds ) const

protected

Definition at line 34 of file surfaceInterpolateFieldsTemplates.C.

References Foam::endl(), fld(), forAll, forAllConstIter(), HashTable::found(), Foam::Info, HashTable::insert(), and Foam::linearInterpolate().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "surfaceInterpolateFields" )

Runtime type information.

◆ name()

virtual const word& name ( ) const

inlinevirtual

Return name of the surfaceInterpolateFields object.

Definition at line 180 of file surfaceInterpolateFields.H.

References surfaceInterpolateFields::name_.

◆ read()

void read ( const dictionary & dict )

virtual

Read the field min/max data.

Definition at line 75 of file surfaceInterpolateFields.C.

References dict, and dictionary::lookup().

Here is the call graph for this function:

◆ execute()

void execute ( )

virtual

Execute, currently does nothing.

Definition at line 85 of file surfaceInterpolateFields.C.

References Foam::endl(), Foam::Info, Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ end()

void end ( )

virtual

Execute at the final time-loop, currently does nothing.

Definition at line 109 of file surfaceInterpolateFields.C.

◆ timeSet()

void timeSet ( )

virtual

Called when time was set at the end of the Time::operator++.

Definition at line 115 of file surfaceInterpolateFields.C.

◆ write()

void write ( )

virtual

Write.

Definition at line 121 of file surfaceInterpolateFields.C.

References Foam::endl(), forAll, Foam::Info, Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ updateMesh()

virtual void updateMesh ( const mapPolyMesh & )

inlinevirtual

Update for changes of mesh.

Definition at line 201 of file surfaceInterpolateFields.H.

◆ movePoints()

virtual void movePoints ( const polyMesh & )

inlinevirtual

Update for changes of mesh.

Definition at line 205 of file surfaceInterpolateFields.H.

Field Documentation

◆ name_

word name_

protected

Name of this set of surfaceInterpolateFields object.

Definition at line 118 of file surfaceInterpolateFields.H.

Referenced by surfaceInterpolateFields::name().

◆ obr_

const objectRegistry& obr_

protected

Definition at line 120 of file surfaceInterpolateFields.H.

◆ active_

bool active_

protected

on/off switch

Definition at line 123 of file surfaceInterpolateFields.H.

◆ fieldSet_

List<Tuple2<word, word> > fieldSet_

protected

Fields to process.

Definition at line 126 of file surfaceInterpolateFields.H.

◆ log_

Switch log_

protected

Switch to send output to Info as well as to file.

Definition at line 129 of file surfaceInterpolateFields.H.

◆ ssf_

PtrList<surfaceScalarField> ssf_

protected

Locally constructed fields.

Definition at line 132 of file surfaceInterpolateFields.H.

◆ svf_

PtrList<surfaceVectorField> svf_

protected

Definition at line 133 of file surfaceInterpolateFields.H.

◆ sSpheretf_

PtrList<surfaceSphericalTensorField> sSpheretf_

protected

Definition at line 134 of file surfaceInterpolateFields.H.

◆ sSymmtf_

PtrList<surfaceSymmTensorField> sSymmtf_

protected

Definition at line 135 of file surfaceInterpolateFields.H.

◆ stf_

PtrList<surfaceTensorField> stf_

protected

Definition at line 136 of file surfaceInterpolateFields.H.

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

src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H
src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.C
src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFieldsTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ surfaceInterpolateFields() [1/2]

◆ surfaceInterpolateFields() [2/2]

◆ ~surfaceInterpolateFields()

Member Function Documentation

◆ operator=()

◆ interpolateFields()

◆ TypeName()

◆ name()

◆ read()

◆ execute()

◆ end()

◆ timeSet()

◆ write()

◆ updateMesh()

◆ movePoints()

Field Documentation

◆ name_

◆ obr_

◆ active_

◆ fieldSet_

◆ log_

◆ ssf_

◆ svf_

◆ sSpheretf_

◆ sSymmtf_

◆ stf_