Provides a 'face regionType' variant of the fieldValues function object. More...

Inheritance diagram for surfaceFieldValue:

Collaboration diagram for surfaceFieldValue:

[legend]

Public Types
enum	regionTypes { faceZone, patch, sampledSurface }
	region type enumeration More...

enum	operationType { none, sum, sumMag, sumDirection, sumDirectionBalance, orientedSum, average, areaAverage, areaIntegrate, min, max, minMag, maxMag, CoV, areaNormalAverage, areaNormalIntegrate }
	Operation type enumeration. More...

Public Member Functions
	TypeName ("surfaceFieldValue")
	Run-time type information. More...

	surfaceFieldValue (const word &name, const Time &runTime, const dictionary &dict)
	Construct from name, Time and dictionary. More...

	surfaceFieldValue (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from name, objectRegistry and dictionary. More...

virtual	~surfaceFieldValue ()
	Destructor. More...

const regionTypes &	regionType () const
	Return the region type. More...

const labelList &	faceId () const
	Return the local list of face IDs. More...

const labelList &	facePatch () const
	Return the local list of patch ID per face. More...

const labelList &	faceSign () const
	Return the list of +1/-1 representing face flip map. More...

fileName	outputDir () const
	Return the output directory. More...

template<class Type >
bool	writeValues (const word &fieldName, const scalarField &signs, const scalarField &weights, const vectorField &Sf)
	Templated helper function to output field values. More...

template<class Type , class ResultType >
bool	writeValues (const word &fieldName, const Field< Type > &values, const scalarField &signs, const scalarField &weights, const vectorField &Sf)
	Templated helper function to output field values. More...

template<class Type >
tmp< Field< Type > >	filterField (const GeometricField< Type, fvsPatchField, surfaceMesh > &field) const
	Filter a surface field according to faceIds. More...

template<class Type >
tmp< Field< Type > >	filterField (const GeometricField< Type, fvPatchField, volMesh > &field) const
	Filter a volume field according to faceIds. More...

virtual bool	read (const dictionary &)
	Read from dictionary. More...

virtual bool	write ()
	Calculate and write. More...

virtual void	movePoints (const polyMesh &)
	Update for mesh point-motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	getFieldValues (const word &fieldName) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	filterField (const GeometricField< Type, fvPatchField, volMesh > &field) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	filterField (const GeometricField< Type, fvsPatchField, surfaceMesh > &field) const

Public Member Functions inherited from fieldValue
	TypeName ("fieldValue")
	Run-time type information. More...

	declareRunTimeSelectionTable (autoPtr, fieldValue, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict),(name, obr, dict))

	fieldValue (const word &name, const Time &runTime, const dictionary &dict, const word &valueType)
	Construct from Time and dictionary. More...

	fieldValue (const word &name, const objectRegistry &obr, const dictionary &dict, const word &valueType)
	Construct from objectRegistry and dictionary. More...

virtual	~fieldValue ()
	Destructor. More...

const dictionary &	dict () const
	Return the reference to the construction dictionary. More...

const word &	regionName () const
	Return the region name. More...

virtual wordList	fields () const
	Return the list of fields required. More...

const Switch &	writeFields () const
	Return the output field values flag. More...

const dictionary &	resultDict () const
	Return access to the latest set of results. More...

virtual bool	execute ()
	Execute. More...

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information. More...

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

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

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

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

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

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

Public Member Functions inherited from logFiles
	logFiles (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

	logFiles (const logFiles &)=delete
	Disallow default bitwise copy construction. More...

virtual	~logFiles ()
	Destructor. More...

const wordList &	names () const
	Return const access to the names. More...

PtrList< OFstream > &	files ()
	Return access to the files. More...

OFstream &	file ()
	Return access to the file (if only 1) More...

OFstream &	file (const label i)
	Return file 'i'. More...

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

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

	writeFile (const writeFile &)=delete
	Disallow default bitwise copy construction. More...

	~writeFile ()
	Destructor. More...

void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

fileName	baseFileDir () const
	Return the base directory for output. More...

fileName	baseTimeDir () const
	Return the base directory for the current time value. More...

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. More...

void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream. More...

void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream. More...

void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream. More...

void	writeTime (Ostream &os) const
	Write the current time to stream. More...

template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair. More...

label	charWidth () const
	Return width of character stream output. More...

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

Static Public Attributes
static const NamedEnum< regionTypes, 3 >	regionTypeNames_
	region type names More...

static const NamedEnum< operationType, 16 >	operationTypeNames_
	Operation type names. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Static Public Attributes inherited from writeFile
static const word	outputPrefix
	Directory prefix. More...

static label	addChars = 8
	Additional characters for writing. More...

Protected Member Functions
void	initialise (const dictionary &dict)
	Initialise, e.g. face addressing. More...

template<class Type >
bool	validField (const word &fieldName) const
	Return true if the field name is valid. More...

template<class Type >
tmp< Field< Type > >	getFieldValues (const word &fieldName) const
	Return field values by looking up field name. More...

template<class Type , class ResultType >
bool	processValues (const Field< Type > &values, const scalarField &signs, const scalarField &weights, const vectorField &Sf, ResultType &result) const
	Apply the operation to the values, and return true if successful. More...

template<class Type >
bool	processValues (const Field< Type > &values, const scalarField &signs, const scalarField &weights, const vectorField &Sf, Type &result) const
	Apply Type -> Type operation to the values. Calls. More...

template<class Type >
bool	processValues (const Field< Type > &values, const scalarField &signs, const scalarField &weights, const vectorField &Sf, scalar &result) const
	Apply Type -> scalar operation to the values. More...

bool	processValues (const Field< scalar > &values, const scalarField &signs, const scalarField &weights, const vectorField &Sf, scalar &result) const
	Apply scalar -> scalar operation to the values. Tries to apply. More...

bool	processValues (const Field< vector > &values, const scalarField &signs, const scalarField &weights, const vectorField &Sf, scalar &result) const
	Apply vector -> vector operation to the values. More...

bool	processValues (const Field< vector > &values, const scalarField &signs, const scalarField &weights, const vectorField &Sf, vector &result) const
	Apply vector -> vector operation to the values. Tries to apply. More...

template<class Type >
bool	processValuesTypeType (const Field< Type > &values, const scalarField &signs, const scalarField &weights, const vectorField &Sf, Type &result) const
	Apply a Type -> Type operation to the values. More...

virtual void	writeFileHeader (const label i)
	Output file header information. More...

Protected Member Functions inherited from fieldValue
template<class Type >
void	combineFields (Field< Type > &field)
	Combine fields from all processor domains into single field. More...

template<class Type >
void	combineFields (tmp< Field< Type >> &)
	Combine fields from all processor domains into single field. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Member Functions inherited from logFiles
virtual void	createFiles ()
	Create the output file. More...

virtual void	resetNames (const wordList &names)
	Reset the list of names from a wordList. More...

virtual void	resetName (const word &name)
	Reset the list of names to a single name entry. More...

Protected Attributes
dictionary	dict_
	Input dictionary. More...

autoPtr< surfaceWriter >	surfaceWriterPtr_
	Surface writer. More...

regionTypes	regionType_
	region type More...

operationType	operation_
	Operation to apply to values. More...

wordList	weightFieldNames_
	Weight field names - optional. More...

scalar	scaleFactor_
	Scale factor - optional. More...

scalar	totalArea_
	Total area of the surfaceFieldValue. More...

bool	writeArea_
	Optionally write the area of the surfaceFieldValue. More...

label	nFaces_
	Global number of faces. More...

labelList	faceId_
	Local list of face IDs. More...

labelList	facePatchId_
	Local list of patch ID per face. More...

labelList	faceSign_
	List of +1/-1 representing face flip map. More...

autoPtr< sampledSurface >	surfacePtr_
	Underlying sampledSurface. More...

Protected Attributes inherited from fieldValue
dictionary	dict_
	Construction dictionary. More...

const word	valueType_
	The name of the type of value (volFieldValue, or surfaceFieldValue) More...

word	regionName_
	Name of region (patch, zone, etc.) More...

wordList	fields_
	List of field names to operate on. More...

Switch	writeFields_
	Output field values flag. More...

dictionary	resultDict_
	Results dictionary for external access of results. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from logFiles
wordList	names_
	File names. More...

PtrList< OFstream >	filePtrs_
	File pointer. More...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const word	prefix_
	Prefix. More...

Additional Inherited Members
Static Public Member Functions inherited from fieldValue
static autoPtr< fieldValue >	New (const word &name, const objectRegistry &obr, const dictionary &dict, const bool output=true)
	Return a reference to the selected fieldValue. More...

Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch write log to Info. More...

Detailed Description

Provides a 'face regionType' variant of the fieldValues function object.

Given a list of user-specified fields and a selection of mesh (or general surface) faces, a number of operations can be performed, such as sums, averages and integrations.

For example, to calculate the volumetric or mass flux across a patch, apply the 'orientedSum' operator to the flux field (typically phi)

Examples of function object specification:

movingWallPatch
{
    type            surfaceFieldValue;
    libs            ("libfieldFunctionObjects.so");

    log             true;
    writeControl    writeTime;
    writeFields     true;

    regionType      patch;
    name            movingWall;

    operation       areaAverage;

    fields
    (
        p
        phi
        U
    );
}

surfaceFieldValue1
{
    type            surfaceFieldValue;
    libs            ("libfieldFunctionObjects.so");

    log             true;
    writeControl    writeTime;
    writeFields     true;

    surfaceFormat   none;
    regionType      faceZone;
    name            f0;

    operation       sum;

    weightField     alpha1;

    fields
    (
        p
        phi
        U
    );
}

Usage

Property	Description	Required	Default value
`type`	type name: surfaceFieldValue	yes
`log`	write data to standard output	no	no
`writeFields`	Write the region field values	yes
`writeArea`	Write the area of the surfaceFieldValue	no
`surfaceFormat`	output value format	no
`regionType`	face regionType: see below	yes
`name`	name of face regionType if required	no
`operation`	operation to perform	yes
`weightField`	name of field to apply weighting	no
`weightFields`	Names of fields to apply weighting	no
`scaleFactor`	scale factor	no	1
`fields`	list of fields to operate on	yes

Where regionType is defined by

faceZone	:	requires a 'name' entry to specify the faceZone
patch	:	requires a 'name' entry to specify the patch
sampledSurface	:	requires a 'sampledSurfaceDict' sub-dictionary

The operation is one of:

none	:	no operation
sum	:	sum
sumMag	:	sum of component magnitudes
sumDirection	:	sum values which are positive in given direction
sumDirectionBalance	:	sum of balance of values in given direction
orientedSum	:	sum with face orientations
average	:	ensemble average
areaAverage	:	area weighted average
areaIntegrate	:	area integral
min	:	minimum
max	:	maximum
minMag	:	minimum magnitude
maxMag	:	maximum magnitude
CoV	:	coefficient of variation: standard deviation/mean
areaNormalAverage	:	area weighted average in face normal direction
areaNormalIntegrate	:	area weighted integral in face normal direction

Note:

Faces on empty patches get ignored.
The `oriented' operations will flip the sign of the field so that all the normals point in a consistent direction. This is only of relevance when summing mesh-oriented fields, such as the flux, on faceZones.
If the field is a volField then a faceZone can only consist of boundary faces, because only these faces have a value associated with them. No cell-to-face interpolation is performed.
If the field is a surfaceField then the region cannot be a sampledSurface
If a sampledSurface has interpolation set to false then the surface face values will be taken directly from the cell that contains the surface face centre
If a sampledSurface has interpolation set to true then the field will be interpolated to the vertices, then averaged onto the surface faces

See also: Foam::fieldValues Foam::functionObject

Source files

Definition at line 321 of file surfaceFieldValue.H.

Member Enumeration Documentation

◆ regionTypes

enum regionTypes

strong

region type enumeration

Enumerator
faceZone
patch
sampledSurface

Definition at line 331 of file surfaceFieldValue.H.

◆ operationType

enum operationType

strong

Operation type enumeration.

Enumerator
none
sum
sumMag
sumDirection
sumDirectionBalance
orientedSum
average
areaAverage
areaIntegrate
min
max
minMag
maxMag
CoV
areaNormalAverage
areaNormalIntegrate

Definition at line 343 of file surfaceFieldValue.H.

Constructor & Destructor Documentation

◆ surfaceFieldValue() [1/2]

surfaceFieldValue	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from name, Time and dictionary.

Definition at line 645 of file surfaceFieldValue.C.

References Foam::read().

Referenced by surfaceFieldValue::processValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ surfaceFieldValue() [2/2]

surfaceFieldValue	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict
	)

Construct from name, objectRegistry and dictionary.

Definition at line 668 of file surfaceFieldValue.C.

References Foam::read().

Here is the call graph for this function:

◆ ~surfaceFieldValue()

~surfaceFieldValue ( )

virtual

Destructor.

Definition at line 693 of file surfaceFieldValue.C.

References surfaceFieldValue::read().

Here is the call graph for this function:

Member Function Documentation

◆ initialise()

void initialise ( const dictionary & dict )

protected

Initialise, e.g. face addressing.

Definition at line 412 of file surfaceFieldValue.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::found(), Foam::Info, dictionary::lookup(), Foam::name(), surfaceWriter::New(), Foam::nl, dictionary::readIfPresent(), Foam::type(), and surfaceFieldValue::writeFileHeader().

Referenced by NamedEnum< compressibleField, 8 >::names().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validField()

bool validField ( const word & fieldName ) const

protected

Return true if the field name is valid.

Definition at line 37 of file surfaceFieldValueTemplates.C.

References surfaceFieldValue::getFieldValues(), and sf().

Here is the call graph for this function:

◆ getFieldValues() [1/2]

tmp<Field<Type> > getFieldValues ( const word & fieldName ) const

protected

Return field values by looking up field name.

Referenced by surfaceFieldValue::validField().

Here is the caller graph for this function:

◆ processValues() [1/6]

bool processValues	(	const Field< Type > &	values,
		const scalarField &	signs,
		const scalarField &	weights,
		const vectorField &	Sf,
		ResultType &	result
	)		const

protected

Apply the operation to the values, and return true if successful.

Does nothing unless overloaded below.

Definition at line 138 of file surfaceFieldValueTemplates.C.

Referenced by surfaceFieldValue::getFieldValues(), surfaceFieldValue::processValues(), and surfaceFieldValue::writeFileHeader().

Here is the caller graph for this function:

◆ processValues() [2/6]

bool processValues	(	const Field< Type > &	values,
		const scalarField &	signs,
		const scalarField &	weights,
		const vectorField &	Sf,
		Type &	result
	)		const

protected

Apply Type -> Type operation to the values. Calls.

processValuesTypeType.

Definition at line 152 of file surfaceFieldValueTemplates.C.

References surfaceFieldValue::processValues().

Here is the call graph for this function:

◆ processValues() [3/6]

bool processValues	(	const Field< Type > &	values,
		const scalarField &	signs,
		const scalarField &	weights,
		const vectorField &	Sf,
		scalar &	result
	)		const

protected

Apply Type -> scalar operation to the values.

Definition at line 166 of file surfaceFieldValueTemplates.C.

References Foam::gMax(), Foam::gMin(), Foam::mag(), and surfaceFieldValue::processValuesTypeType().

Here is the call graph for this function:

◆ processValues() [4/6]

bool processValues	(	const Field< scalar > &	values,
		const scalarField &	signs,
		const scalarField &	weights,
		const vectorField &	Sf,
		scalar &	result
	)		const

protected

Apply scalar -> scalar operation to the values. Tries to apply.

scalar -> scalar specific operations, otherwise calls processValuesTypeType.

Definition at line 533 of file surfaceFieldValue.C.

References Foam::gSum(), Foam::mag(), n, Foam::neg(), Foam::pos0(), and surfaceFieldValue::processValues().

Here is the call graph for this function:

◆ processValues() [5/6]

bool processValues	(	const Field< vector > &	values,
		const scalarField &	signs,
		const scalarField &	weights,
		const vectorField &	Sf,
		scalar &	result
	)		const

protected

Apply vector -> vector operation to the values.

Definition at line 573 of file surfaceFieldValue.C.

References Foam::gSum(), Foam::mag(), and surfaceFieldValue::processValues().

Here is the call graph for this function:

◆ processValues() [6/6]

bool processValues	(	const Field< vector > &	values,
		const scalarField &	signs,
		const scalarField &	weights,
		const vectorField &	Sf,
		vector &	result
	)		const

protected

Apply vector -> vector operation to the values. Tries to apply.

vector -> vector specific operations, otherwise calls processValuesTypeType.

Definition at line 602 of file surfaceFieldValue.C.

References Foam::gSum(), n, Foam::normalised(), Foam::pos0(), and surfaceFieldValue::surfaceFieldValue().

Here is the call graph for this function:

◆ processValuesTypeType()

bool processValuesTypeType	(	const Field< Type > &	values,
		const scalarField &	signs,
		const scalarField &	weights,
		const vectorField &	Sf,
		Type &	result
	)		const

protected

Apply a Type -> Type operation to the values.

Definition at line 197 of file surfaceFieldValueTemplates.C.

References Foam::fvc::average(), Foam::cmptMag(), Foam::component(), Field< Type >::component(), Foam::gMax(), Foam::gMin(), Foam::gSum(), Foam::mag(), Foam::max(), Foam::min(), Foam::setComponent(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), Foam::sum(), Foam::sumMag(), and surfaceFieldValue::writeValues().

Referenced by surfaceFieldValue::processValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFileHeader()

void writeFileHeader ( const label i )

protectedvirtual

Output file header information.

Implements logFiles.

Definition at line 501 of file surfaceFieldValue.C.

References Foam::endl(), Foam::file, forAll, surfaceFieldValue::processValues(), and Foam::tab.

Referenced by surfaceFieldValue::initialise().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "surfaceFieldValue" )

Run-time type information.

◆ regionType()

const Foam::functionObjects::fieldValues::surfaceFieldValue::regionTypes & regionType ( ) const

inline

Return the region type.

Definition at line 32 of file surfaceFieldValueI.H.

References surfaceFieldValue::regionType_.

◆ faceId()

const Foam::labelList & faceId ( ) const

inline

Return the local list of face IDs.

Definition at line 39 of file surfaceFieldValueI.H.

References surfaceFieldValue::faceId_.

◆ facePatch()

const Foam::labelList & facePatch ( ) const

inline

Return the local list of patch ID per face.

Definition at line 46 of file surfaceFieldValueI.H.

References surfaceFieldValue::facePatchId_.

◆ faceSign()

const Foam::labelList & faceSign ( ) const

inline

Return the list of +1/-1 representing face flip map.

Definition at line 53 of file surfaceFieldValueI.H.

References surfaceFieldValue::faceSign_.

◆ outputDir()

Foam::fileName outputDir ( ) const

inline

Return the output directory.

Definition at line 60 of file surfaceFieldValueI.H.

References writeFile::baseFileDir(), functionObject::name(), regionFunctionObject::obr_, objectRegistry::time(), and Time::timeName().

Here is the call graph for this function:

◆ writeValues() [1/2]

bool writeValues	(	const word &	fieldName,
		const scalarField &	signs,
		const scalarField &	weights,
		const vectorField &	Sf
	)

Templated helper function to output field values.

Definition at line 288 of file surfaceFieldValueTemplates.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, FOR_ALL_FIELD_TYPES, points, and writeValuesFieldType.

Referenced by surfaceFieldValue::processValuesTypeType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeValues() [2/2]

bool writeValues	(	const word &	fieldName,
		const Field< Type > &	values,
		const scalarField &	signs,
		const scalarField &	weights,
		const vectorField &	Sf
	)

Templated helper function to output field values.

Definition at line 376 of file surfaceFieldValueTemplates.C.

References Foam::endl(), Foam::file, surfaceFieldValue::filterField(), Log, and Foam::tab.

Here is the call graph for this function:

◆ filterField() [1/4]

tmp<Field<Type> > filterField ( const GeometricField< Type, fvsPatchField, surfaceMesh > & field ) const

Filter a surface field according to faceIds.

Referenced by surfaceFieldValue::filterField(), and surfaceFieldValue::writeValues().

Here is the caller graph for this function:

◆ filterField() [2/4]

tmp<Field<Type> > filterField ( const GeometricField< Type, fvPatchField, volMesh > & field ) const

Filter a volume field according to faceIds.

◆ read()

bool read ( const dictionary & dict )

virtual

Read from dictionary.

Reimplemented from fieldValue.

Definition at line 700 of file surfaceFieldValue.C.

References fieldValue::read().

Referenced by surfaceFieldValue::~surfaceFieldValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

bool write ( )

virtual

Calculate and write.

Reimplemented from fieldValue.

Definition at line 711 of file surfaceFieldValue.C.

References Foam::endl(), Foam::file, Foam::FOR_ALL_FIELD_TYPES(), forAll, Log, UPstream::master(), surfaceFieldValue::movePoints(), points, List< T >::size(), Foam::tab, WarningInFunction, fieldValue::write(), and writeValuesFieldType.

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for mesh point-motion.

Reimplemented from functionObject.

Definition at line 824 of file surfaceFieldValue.C.

References surfaceFieldValue::topoChange().

Referenced by surfaceFieldValue::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 838 of file surfaceFieldValue.C.

References surfaceFieldValue::mapMesh(), and polyTopoChangeMap::mesh().

Referenced by surfaceFieldValue::movePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 850 of file surfaceFieldValue.C.

References polyMeshMap::mesh().

Referenced by surfaceFieldValue::topoChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldValues() [2/2]

Foam::tmp<Foam::Field<Type> > getFieldValues ( const word & fieldName ) const

Definition at line 64 of file surfaceFieldValueTemplates.C.

References Foam::abort(), f(), Foam::FatalError, FatalErrorInFunction, fld(), forAll, Foam::fvc::interpolate(), surfaceFieldValue::processValues(), tmp< T >::ref(), sf(), List< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ filterField() [3/4]

Foam::tmp<Foam::Field<Type> > filterField ( const GeometricField< Type, fvPatchField, volMesh > & field ) const

Definition at line 410 of file surfaceFieldValueTemplates.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Foam::FatalError, FatalErrorInFunction, surfaceFieldValue::filterField(), forAll, Foam::name(), IOobject::name(), Foam::nl, patchi, tmp< T >::ref(), and Foam::type().

Here is the call graph for this function:

◆ filterField() [4/4]

Foam::tmp<Foam::Field<Type> > filterField ( const GeometricField< Type, fvsPatchField, surfaceMesh > & field ) const

Definition at line 444 of file surfaceFieldValueTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, patchi, and tmp< T >::ref().

Here is the call graph for this function:

Member Data Documentation

◆ regionTypeNames_

const Foam::NamedEnum< Foam::functionObjects::fieldValues::surfaceFieldValue::regionTypes, 3 > regionTypeNames_

static

region type names

Definition at line 339 of file surfaceFieldValue.H.

Referenced by NamedEnum< compressibleField, 8 >::names().

◆ operationTypeNames_

const Foam::NamedEnum< Foam::functionObjects::fieldValues::surfaceFieldValue::operationType, 16 > operationTypeNames_

static

Operation type names.

Definition at line 364 of file surfaceFieldValue.H.

Referenced by NamedEnum< compressibleField, 8 >::names().

◆ dict_

dictionary dict_

protected

Input dictionary.

Definition at line 403 of file surfaceFieldValue.H.

◆ surfaceWriterPtr_

autoPtr<surfaceWriter> surfaceWriterPtr_

protected

Surface writer.

Definition at line 406 of file surfaceFieldValue.H.

◆ regionType_

regionTypes regionType_

protected

region type

Definition at line 409 of file surfaceFieldValue.H.

Referenced by surfaceFieldValue::regionType().

◆ operation_

operationType operation_

protected

Operation to apply to values.

Definition at line 412 of file surfaceFieldValue.H.

◆ weightFieldNames_

wordList weightFieldNames_

protected

Weight field names - optional.

Definition at line 415 of file surfaceFieldValue.H.

◆ scaleFactor_

scalar scaleFactor_

protected

Scale factor - optional.

Definition at line 418 of file surfaceFieldValue.H.

◆ totalArea_

scalar totalArea_

protected

Total area of the surfaceFieldValue.

Definition at line 421 of file surfaceFieldValue.H.

◆ writeArea_

bool writeArea_

protected

Optionally write the area of the surfaceFieldValue.

Definition at line 424 of file surfaceFieldValue.H.

◆ nFaces_

label nFaces_

protected

Global number of faces.

Definition at line 427 of file surfaceFieldValue.H.

◆ faceId_

labelList faceId_

protected

Local list of face IDs.

Definition at line 433 of file surfaceFieldValue.H.

Referenced by surfaceFieldValue::faceId().

◆ facePatchId_

labelList facePatchId_

protected

Local list of patch ID per face.

Definition at line 436 of file surfaceFieldValue.H.

Referenced by surfaceFieldValue::facePatch().

◆ faceSign_

labelList faceSign_

protected

List of +1/-1 representing face flip map.

(1 use as is, -1 negate)

Definition at line 440 of file surfaceFieldValue.H.

Referenced by surfaceFieldValue::faceSign().

◆ surfacePtr_

autoPtr<sampledSurface> surfacePtr_

protected

Underlying sampledSurface.

Definition at line 446 of file surfaceFieldValue.H.

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

src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.C
src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValueI.H
src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValueTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ regionTypes

◆ operationType

Constructor & Destructor Documentation

◆ surfaceFieldValue() [1/2]

◆ surfaceFieldValue() [2/2]

◆ ~surfaceFieldValue()

Member Function Documentation

◆ initialise()

◆ validField()

◆ getFieldValues() [1/2]

◆ processValues() [1/6]

◆ processValues() [2/6]

◆ processValues() [3/6]

◆ processValues() [4/6]

◆ processValues() [5/6]

◆ processValues() [6/6]

◆ processValuesTypeType()

◆ writeFileHeader()

◆ TypeName()

◆ regionType()

◆ faceId()

◆ facePatch()

◆ faceSign()

◆ outputDir()

◆ writeValues() [1/2]

◆ writeValues() [2/2]

◆ filterField() [1/4]

◆ filterField() [2/4]

◆ read()

◆ write()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ getFieldValues() [2/2]

◆ filterField() [3/4]

◆ filterField() [4/4]

Member Data Documentation

◆ regionTypeNames_

◆ operationTypeNames_

◆ dict_

◆ surfaceWriterPtr_

◆ regionType_

◆ operation_

◆ weightFieldNames_

◆ scaleFactor_

◆ totalArea_

◆ writeArea_

◆ nFaces_

◆ faceId_

◆ facePatchId_

◆ faceSign_

◆ surfacePtr_