A face regionType variant of the fieldValues function object. More...

Inheritance diagram for surfaceFieldValue:

Collaboration diagram for surfaceFieldValue:

[legend]

Public Types
enum	regionTypes { stFaceZone = 0x01, stPatch = 0x02, stObject = 0x11, stSampled = 0x12 }
	Region type enumeration. More...

enum	operationType { opNone = 0, opMin, opMax, opSum, opSumMag, opSumDirection, opSumDirectionBalance, opAverage, opAreaAverage, opAreaIntegrate, opCoV, typeScalar = 0x100, opAreaNormalAverage = (1 \| typeScalar), opAreaNormalIntegrate, opUniformity, typeWeighted = 0x200, opWeightedSum = (opSum \| typeWeighted), opWeightedAverage = (opAverage \| typeWeighted), opWeightedAreaAverage = (opAreaAverage \| typeWeighted), opWeightedAreaIntegrate = (opAreaIntegrate \| typeWeighted), opWeightedUniformity = (opUniformity \| typeWeighted), typeAbsolute = 0x400, opAbsWeightedSum = (opWeightedSum \| typeAbsolute), opAbsWeightedAverage = (opWeightedAverage \| typeAbsolute), opAbsWeightedAreaAverage = (opWeightedAreaAverage \| typeAbsolute), opAbsWeightedAreaIntegrate, opAbsWeightedUniformity }
	Operation type enumeration. More...

enum	postOperationType { postOpNone, postOpMag, postOpSqrt }
	Post-operation type enumeration. More...

Public Member Functions
	TypeName ("surfaceFieldValue")
	Declare type-name, virtual type (with debug switch) 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...

	surfaceFieldValue (const surfaceFieldValue &)=delete
	No copy construct. More...

void	operator= (const surfaceFieldValue &)=delete
	No copy assignment. More...

virtual	~surfaceFieldValue ()
	Destructor. More...

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

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

virtual bool	read (const dictionary &dict)
	Read the function-object dictionary. More...

virtual bool	write ()
	Write the function-object results. More...

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

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

template<>
Foam::scalar	processValues (const Field< scalar > &values, const vectorField &Sf, const scalarField &weightField) const

template<>
Foam::vector	processValues (const Field< vector > &values, const vectorField &Sf, const scalarField &weightField) const

template<>
Foam::tmp< Foam::scalarField >	weightingFactor (const Field< scalar > &weightField, const bool useMag)

template<>
Foam::tmp< Foam::scalarField >	weightingFactor (const Field< scalar > &weightField, const vectorField &Sf, const bool useMag)

template<>
Foam::tmp< Foam::scalarField >	areaWeightingFactor (const Field< scalar > &weightField, const vectorField &Sf, const bool useMag)

template<>
Foam::tmp< Foam::scalarField >	weightingFactor (const Field< vector > &weightField, const vectorField &Sf, const bool useMag)

template<>
Foam::tmp< Foam::scalarField >	areaWeightingFactor (const Field< vector > &weightField, const vectorField &Sf, const bool useMag)

template<>
scalar	processValues (const Field< scalar > &values, const vectorField &Sf, const scalarField &weightField) const
	Specialisation for scalar fields. More...

template<>
vector	processValues (const Field< vector > &values, const vectorField &Sf, const scalarField &weightField) const
	Specialisation for vector fields. More...

template<>
tmp< scalarField >	weightingFactor (const Field< scalar > &weightField, const bool useMag)
	Specialisation for scalar - pass through. More...

template<>
tmp< scalarField >	weightingFactor (const Field< scalar > &weightField, const vectorField &Sf, const bool useMag)
	Specialisation for scalar - pass through. More...

template<>
tmp< scalarField >	areaWeightingFactor (const Field< scalar > &weightField, const vectorField &Sf, const bool useMag)
	Specialisation for scalar - scalar * Area. More...

template<>
tmp< scalarField >	weightingFactor (const Field< vector > &weightField, const vectorField &Sf, const bool useMag)
	Specialisation for vector - vector (dot) unit-normal. More...

template<>
tmp< scalarField >	areaWeightingFactor (const Field< vector > &weightField, const vectorField &Sf, const bool useMag)
	Specialisation for vector - vector (dot) Area. More...

template<class WeightType >
Foam::tmp< Foam::scalarField >	weightingFactor (const Field< WeightType > &weightField, const bool useMag)

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

template<class WeightType >
Foam::label	writeAll (const vectorField &Sf, const Field< WeightType > &weightField, const pointField &points, const faceList &faces)

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, runTime,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	fieldValue (const word &name, const Time &runTime, const dictionary &dict, const word &valueType)
	Construct from name, 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 ()=default
	Destructor. More...

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

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

const wordList &	fields () const noexcept
	Return the list of field names. More...

bool	writeFields () const noexcept
	Return the output field values flag. More...

virtual bool	execute ()
	Execute the function-object operations. 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...

virtual	~fvMeshFunctionObject ()=default
	Destructor. 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...

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

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

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

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri)
	Set new trigger index. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

bool	getObjectResultDict (const word &objectName, dictionary &dict) const

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

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

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time. More...

const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time. More...

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

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

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

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

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

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

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

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName. More...

	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName and read options from dictionary. More...

	writeFile (const writeFile &wf)
	Construct copy. More...

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

virtual const string &	setExt (const string &ext)
	Set extension. More...

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

virtual bool	writeToFile () const
	Flag to allow writing to file. More...

virtual bool	canWriteToFile () const
	Flag to allow writing to the file. More...

virtual bool	canResetFile () const
	Flag to allow resetting the file. More...

virtual bool	canWriteHeader () const
	Flag to allow writing the header. More...

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

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

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

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

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

virtual void	writeBreak (Ostream &os) const
	Write a break marker to the 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...

template<class Type >
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter. More...

Static Public Attributes
static const Enum< regionTypes >	regionTypeNames_
	Region type names. More...

static const Enum< operationType >	operationTypeNames_
	Operation type names. More...

static const Enum< postOperationType >	postOperationTypeNames_
	Operation type names. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing. More...

Protected Member Functions
const objectRegistry &	obr () const
	The volume mesh or surface registry being used. More...

bool	withSurfaceFields () const
	Can the surface definition sample surface-fields? More...

bool	withTopologicalMerge () const noexcept
	Can use mesh topological merge? More...

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

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

const boolList &	faceFlip () const noexcept
	Return the local true/false list representing the face flip map. More...

bool	usesSf () const noexcept
	True if the operation needs a surface Sf. More...

bool	is_magOp () const noexcept
	True if the operation variant uses mag. More...

bool	is_weightedOp () const noexcept
	True if the operation variant uses a weight-field. More...

template<class WeightType >
bool	canWeight (const Field< WeightType > &fld) const
	True if field is non-empty on any processor. More...

bool	update ()
	Update the surface and surface information as required. More...

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

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

template<class Type , class WeightType >
Type	processSameTypeValues (const Field< Type > &values, const vectorField &Sf, const Field< WeightType > &weightField) const
	Apply the 'operation' to the values. Operation must preserve Type. More...

template<class Type , class WeightType >
Type	processValues (const Field< Type > &values, const vectorField &Sf, const Field< WeightType > &weightField) const
	Apply the 'operation' to the values. Wrapper around. 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...

template<class WeightType >
label	writeAll (const vectorField &Sf, const Field< WeightType > &weightField, const pointField &points, const faceList &faces)
	Templated helper function to output field values. More...

template<class Type , class WeightType >
bool	writeValues (const word &fieldName, const vectorField &Sf, const Field< WeightType > &weightField, const pointField &points, const faceList &faces)
	Templated helper function to output field values. More...

virtual void	writeFileHeader (Ostream &os)
	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 fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

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

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry. More...

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

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

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

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

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

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Member Functions inherited from writeFile
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...

fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name. More...

virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name. More...

virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time. More...

virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name. More...

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

void	operator= (const writeFile &)=delete
	No copy assignment. More...

virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time. More...

Static Protected Member Functions
template<class WeightType >
static tmp< scalarField >	weightingFactor (const Field< WeightType > &weightField, const bool useMag)
	Weighting factor. More...

template<class WeightType >
static tmp< scalarField >	weightingFactor (const Field< WeightType > &weightField, const vectorField &Sf, const bool useMag)
	Weighting factor, weight field projected onto unit-normal. More...

template<class WeightType >
static tmp< scalarField >	areaWeightingFactor (const Field< WeightType > &weightField, const vectorField &Sf, const bool useMag)
	Weighting factor, weight field with area factor. More...

Protected Attributes
regionTypes	regionType_
	Region type. More...

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

postOperationType	postOperation_
	Optional post-evaluation operation. More...

bool	needsUpdate_
	Track if the surface needs an update. More...

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

error::handlerTypes	emptySurfaceError_
	Handling of empty surfaces (nFaces = 0). Default is Fatal. More...

wordRes	selectionNames_
	Extended selections. More...

wordList	weightFieldNames_
	Weight field name(s) - optional. More...

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

label	nFaces_
	Global number of faces. More...

unsigned	nWarnings_
	Number of warnings emitted since the last valid update. More...

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

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

boolList	faceFlip_
	List representing the face flip map. More...

autoPtr< sampledSurface >	sampledPtr_
	The sampledSurface (when operating on sampledSurface) More...

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

Protected Attributes inherited from fieldValue
bool	writeFields_
	Flag to output field values. More...

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

scalar	scaleFactor_
	Scaling factor. More...

dictionary	dict_
	Construction dictionary. More...

wordList	fields_
	Names of operand fields. More...

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

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

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

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

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

const fileName	prefix_
	Prefix. More...

word	fileName_
	Name of file. More...

autoPtr< OFstream >	filePtr_
	File pointer. More...

label	writePrecision_
	Write precision. More...

bool	writeToFile_
	Flag to enable/disable writing to file. More...

bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true. More...

bool	writtenHeader_
	Flag to identify whether the header has been written. More...

bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true. More...

scalar	startTime_
	Start time value. More...

string	ext_
	File extension; default = .dat. More...

Additional Inherited Members
Static Public Member Functions inherited from fieldValue
static autoPtr< fieldValue >	New (const word &name, const Time &runTime, 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 &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Detailed Description

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 sum operator to the flux field (typically phi).

Usage

A minimal example:

surfaceFieldValuePatchFO
{
    // Mandatory entries
    type            surfaceFieldValue;
    libs            (fieldFunctionObjects);
    fields          <wordList>;  // (<field1> <field2> ... <fieldN>);
    regionType      <word>;
    operation       <word>;

    // Optional entries
    postOperation   <word>;
    writeArea       <bool>;
    empty-surface   <word>;  // default | warn | ignore | strict
    names           (<patch-name> <patch-regex>);
    name            <patch>;
    weightField     <word>;  // alpha1;

    // Conditional entries

        // when regionType = sampledSurface
        sampledSurfaceDict  <dict>;

        // when writeFields = true
        surfaceFormat   <word>;  // vtk | raw | none

    // Inherited entries
    ...
}

where the entries mean:
<table class="OFTable">
<tr>
    <th align="center"><b>      Property     </b></th>
    <th align="center"><b> Description                        </b></th>
    <th align="center"><b> Type </b></th>
    <th align="center"><b> Reqd </b></th>
    <th align="center"><b> Deflt</b></th>
</tr>
<tr>
    <td>\c       type         </td>
    <td> Type name: surfaceFieldValue       </td>
    <td> word </td>
    <td>  yes  </td>
    <td> -</td>
</tr>
<tr>
    <td>\c       libs         </td>
    <td> Libraries: fieldFunctionObjects    </td>
    <td> wordList </td>
    <td>  yes  </td>
    <td> -</td>
</tr>
<tr>
    <td>\c       regionType   </td>
    <td> Face regionType: see below         </td>
    <td> word </td>
    <td>  yes  </td>
    <td> -</td>
</tr>
<tr>
    <td>\c       fields       </td>
    <td> Names of operand fields            </td>
    <td> wordList </td>
    <td> yes </td>
    <td> -</td>
</tr>
<tr>
    <td>\c       name         </td>
    <td> Name of the regionType             </td>
    <td> word </td>
    <td>  yes  </td>
    <td> -</td>
</tr>
<tr>
    <td>\c       names        </td>
    <td> Extended selection              </td>
    <td> word/regex list </td>
    <td> no </td>
    <td> -</td>
</tr>
<tr>
    <td>\c       operation    </td>
    <td> Operation type: see below          </td>
    <td> word </td>
    <td>  yes  </td>
    <td> -</td>
</tr>
<tr>
    <td>\c       postOperation </td>
    <td> Post-operation type: see below    </td>
    <td> word </td>
    <td>  no   </td>
    <td> none</td>
</tr>
<tr>
    <td>\c       weightField   </td>
    <td> Name of field to apply weighting   </td>
    <td> word </td>
    <td>  maybe </td>
    <td></td>
</tr>
<tr>
    <td>\c       weightFields  </td>
    <td> Names of fields to apply weighting </td>
    <td> wordList </td>
    <td> maybe </td>
    <td></td>
</tr>
<tr>
    <td>\c       writeArea    </td>
    <td> Write the surface area             </td>
    <td> bool </td>
    <td>  no   </td>
    <td> false</td>
</tr>
<tr>
    <td>\c       surfaceFormat </td>
    <td> Output value format               </td>
    <td> word <!--</td>
</tr>
<tr>
    <td>\c                 --> </td>
    <td> conditional on writeFields  </td>
    <td> none</td>
</tr>
<tr>
    <td>\c       empty-surface </td>
    <td> Error handling for empty surfaces </td>
    <td> enum </td>
    <td> no </td>
    <td> default</td>
</tr>
<tr>
    <td>\c       sampledSurfaceDict </td>
    <td> Dict defining the sampledSurface </td>
    <td> dict </td>
    <td> no </td>
    <td> -</td>
</tr>
</table>

    The inherited entries are elaborated in:
      - \link fieldValue.H \endlink

    Options for the \c regionType entry:
<table border=0>
<tr>
    <td style="padding-left: 10px">      faceZone      </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> The \b name entry specifies a faceZone. Supports \b names</td>
</tr>
<tr>
    <td style="padding-left: 10px">      patch         </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> The \b name entry specifies a patch. Supports \b names</td>
</tr>
<tr>
    <td style="padding-left: 10px">      functionObjectSurface </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> The \b name entry specifies a polySurface</td>
</tr>
<tr>
    <td style="padding-left: 10px">      sampledSurface        </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> A \b sampledSurfaceDict sub-dictionary and \b name</td>
</tr>
</table>

    Options for the \c operation entry:
<table border=0>
<tr>
    <td style="padding-left: 10px">      none          </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> no operation</td>
</tr>
<tr>
    <td style="padding-left: 10px">      min           </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> minimum</td>
</tr>
<tr>
    <td style="padding-left: 10px">      max           </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> maximum</td>
</tr>
<tr>
    <td style="padding-left: 10px">      sum           </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> sum</td>
</tr>
<tr>
    <td style="padding-left: 10px">      sumMag        </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> sum of component magnitudes</td>
</tr>
<tr>
    <td style="padding-left: 10px">      sumDirection  </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> sum values that are positive in given direction</td>
</tr>
<tr>
    <td style="padding-left: 10px">      sumDirectionBalance </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> sum of balance of values in given direction</td>
</tr>
<tr>
    <td style="padding-left: 10px">      average       </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> ensemble average</td>
</tr>
<tr>
    <td style="padding-left: 10px">      areaAverage   </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> area-weighted average</td>
</tr>
<tr>
    <td style="padding-left: 10px">      areaIntegrate </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> area integral</td>
</tr>
<tr>
    <td style="padding-left: 10px">      CoV           </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> coefficient of variation: standard deviation/mean</td>
</tr>
<tr>
    <td style="padding-left: 10px">      areaNormalAverage </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> area-weighted average in face normal direction</td>
</tr>
<tr>
    <td style="padding-left: 10px">      areaNormalIntegrate </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> area-weighted integral in face normal directon</td>
</tr>
<tr>
    <td style="padding-left: 10px">      uniformity    </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> uniformity index</td>
</tr>
<tr>
    <td style="padding-left: 10px">      weightedSum           </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> weighted sum</td>
</tr>
<tr>
    <td style="padding-left: 10px">      weightedAverage       </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> weighted average</td>
</tr>
<tr>
    <td style="padding-left: 10px">      weightedAreaAverage   </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> weighted area average</td>
</tr>
<tr>
    <td style="padding-left: 10px">      weightedAreaIntegrate </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> weighted area integral</td>
</tr>
<tr>
    <td style="padding-left: 10px">      weightedUniformity    </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> weighted uniformity index</td>
</tr>
<tr>
    <td style="padding-left: 10px">      absWeightedSum           </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> sum using absolute weighting</td>
</tr>
<tr>
    <td style="padding-left: 10px">      absWeightedAverage       </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> average using absolute weighting</td>
</tr>
<tr>
    <td style="padding-left: 10px">      absWeightedAreaAverage   </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> area average using absolute weighting</td>
</tr>
<tr>
    <td style="padding-left: 10px">      absWeightedAreaIntegrate </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> area integral using absolute weighting</td>
</tr>
<tr>
    <td style="padding-left: 10px">      absWeightedUniformity    </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> uniformity index using absolute weighting</td>
</tr>
</table>

    Options for the \c postOperation entry:
<table border=0>
<tr>
    <td style="padding-left: 10px">       none          </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> No additional operation after calculation</td>
</tr>
<tr>
    <td style="padding-left: 10px">       mag           </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> Component-wise \c mag() after normal operation</td>
</tr>
<tr>
    <td style="padding-left: 10px">       sqrt          </td>
    <td style="padding-left: 10px; padding-right: 10px;">:</td>
    <td> Component-wise \c sqrt() after normal operation</td>
</tr>
</table>

\note
- Some types (eg, patch or faceZone) support the selection of multiple
  entries, which can be specified as list of words or regular expressions
  by \b names entry.<br>
  If the \b names enty exists \em and contains a literal that can be used
  as a suitable value for \b name, the \b name entry becomes optional
  instead of being mandatory.
- The values reported by the \c areaNormalAverage and \c areaNormalIntegrate
  operations are written as the first component of a field with the same
  rank as the input field.
- Faces on empty patches are ignored.
- Using \c functionObjectSurface:
  - The keyword %subRegion should not be used to select surfaces.
    Instead specify the regionType 'functionObjectSurface' and provide
    the name.
- Using \c sampledSurface:
    - surface fields only supported by some surfaces
    - default uses sampleScheme \c cell
    - each face in \c sampledSurface is logically only in one cell
      so sampling will be wrong when they are larger than cells.
      This can only happen for sampling on a \c triSurfaceMesh
    - take care when using isoSurfaces - these might have duplicate
      triangles and so integration might be wrong

Uniformity:
\f[
    UI(\phi) = 1 - \frac{1}{2 \overline{\phi} A}
    \int{\left| W \phi \cdot \hat{n} - \bar{W} \bar{\phi}\right| d\vec{A}}
    \,,\;
    \bar{\phi} = \frac{\int{W \phi \cdot d\vec{A}}}{\int{W \cdot d\vec{A}}}
\f]

A velocity uniformity index is calculated with no weighting (W=1) and
\f$ \phi = \vec{U} \f$.

A scalar concentration uniformity index is calculated with either
\f$ \rho \vec U \f$ or \f$ \vec U \f$ for weighting and
\f$ \phi = conc \f$.

\par Source files
<ul>
  <li><a href="https://gitlab.com/openfoam/core/openfoam/blob/OpenFOAM-v2606/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H">surfaceFieldValue.H</a></li> 
  <li><a href="https://gitlab.com/openfoam/core/openfoam/blob/OpenFOAM-v2606/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.C">surfaceFieldValue.C</a></li>
  <li><a href="https://gitlab.com/openfoam/core/openfoam/blob/OpenFOAM-v2606/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValueTemplates.C">surfaceFieldValueTemplates.C</a></li>
</ul>

Definition at line 426 of file surfaceFieldValue.H.

Member Enumeration Documentation

◆ regionTypes

enum regionTypes

Region type enumeration.

Enumerator
stFaceZone	Calculate with faceZone(s)
stPatch	Calculate with patch(es)
stObject	Calculate with function object surface.
stSampled	Sample onto surface and calculate.

Definition at line 437 of file surfaceFieldValue.H.

◆ operationType

enum operationType

Operation type enumeration.

Enumerator
opNone	No operation.
opMin	Minimum value.
opMax	Maximum value.
opSum	Sum of values.
opSumMag	Sum of component magnitudes.
opSumDirection	Sum in a given direction.
opSumDirectionBalance	Sum of balance of values in given direction.
opAverage	Ensemble average.
opAreaAverage	Area average.
opAreaIntegrate	Area integral.
opCoV	Coefficient of variation.
typeScalar
opAreaNormalAverage	Area average in normal direction (output is always scalar)
opAreaNormalIntegrate	Area integral in normal direction (output is always scalar)
opUniformity	Uniformity index (output is always scalar)
typeWeighted
opWeightedSum	Weighted sum.
opWeightedAverage	Weighted average.
opWeightedAreaAverage	Weighted area average.
opWeightedAreaIntegrate	Weighted area integral.
opWeightedUniformity	Weighted uniformity index.
typeAbsolute
opAbsWeightedSum	Sum using abs weighting.
opAbsWeightedAverage	Average using abs weighting.
opAbsWeightedAreaAverage	Area average using abs weighting.
opAbsWeightedAreaIntegrate	Area integral using abs weighting.
opAbsWeightedUniformity	Uniformity index using abs weighting.

Definition at line 453 of file surfaceFieldValue.H.

◆ postOperationType

enum postOperationType

Post-operation type enumeration.

Enumerator
postOpNone	No additional operation after calculation.
postOpMag	Component-wise mag after normal operation.
postOpSqrt	Component-wise sqrt after normal operation.

Definition at line 534 of file surfaceFieldValue.H.

Constructor & Destructor Documentation

◆ surfaceFieldValue() [1/3]

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

Construct from name, Time and dictionary.

Definition at line 1056 of file surfaceFieldValue.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ surfaceFieldValue() [2/3]

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

Construct from name, objectRegistry and dictionary.

Definition at line 1092 of file surfaceFieldValue.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ surfaceFieldValue() [3/3]

surfaceFieldValue ( const surfaceFieldValue & )

delete

No copy construct.

◆ ~surfaceFieldValue()

~surfaceFieldValue ( )

virtual

Destructor.

Definition at line 1130 of file surfaceFieldValue.C.

Member Function Documentation

◆ weightingFactor() [1/9]

static tmp<scalarField> weightingFactor	(	const Field< WeightType > &	weightField,
		const bool	useMag
	)

staticprotected

Weighting factor.

Possibly applies mag() depending on the operation type.

◆ weightingFactor() [2/9]

static tmp<scalarField> weightingFactor	(	const Field< WeightType > &	weightField,
		const vectorField &	Sf,
		const bool	useMag
	)

staticprotected

Weighting factor, weight field projected onto unit-normal.

Possibly applies mag() depending on the operation type. Reverts to 'one' if the weight field is unavailable.

◆ areaWeightingFactor() [1/5]

static tmp<scalarField> areaWeightingFactor	(	const Field< WeightType > &	weightField,
		const vectorField &	Sf,
		const bool	useMag
	)

staticprotected

Weighting factor, weight field with area factor.

Possibly applies mag() depending on the operation type. Reverts to mag(Sf) if the weight field is unavailable.

◆ obr()

const Foam::objectRegistry & obr ( ) const

protectedvirtual

The volume mesh or surface registry being used.

Reimplemented from regionFunctionObject.

Definition at line 115 of file surfaceFieldValue.C.

References objectRegistry::lookupObject(), fvMeshFunctionObject::mesh_, fieldValue::regionName_, surfaceFieldValue::regionType_, surfaceFieldValue::stObject, and timeFunctionObject::storedObjects().

Here is the call graph for this function:

◆ withSurfaceFields()

bool withSurfaceFields ( ) const

inlineprotected

Can the surface definition sample surface-fields?

Definition at line 28 of file surfaceFieldValueI.H.

References surfaceFieldValue::regionType_, surfaceFieldValue::sampledPtr_, surfaceFieldValue::stFaceZone, and surfaceFieldValue::stPatch.

◆ withTopologicalMerge()

bool withTopologicalMerge ( ) const

inlineprotectednoexcept

Can use mesh topological merge?

Definition at line 40 of file surfaceFieldValueI.H.

◆ faceId()

const Foam::labelList & faceId ( ) const

inlineprotectednoexcept

Return the local list of face IDs.

Definition at line 47 of file surfaceFieldValueI.H.

◆ facePatch()

const Foam::labelList & facePatch ( ) const

inlineprotectednoexcept

Return the local list of patch ID per face.

Definition at line 55 of file surfaceFieldValueI.H.

◆ faceFlip()

const Foam::boolList & faceFlip ( ) const

inlineprotectednoexcept

Return the local true/false list representing the face flip map.

Definition at line 63 of file surfaceFieldValueI.H.

◆ usesSf()

bool usesSf ( ) const

protectednoexcept

True if the operation needs a surface Sf.

Definition at line 562 of file surfaceFieldValue.C.

◆ is_magOp()

bool is_magOp ( ) const

inlineprotectednoexcept

True if the operation variant uses mag.

Definition at line 73 of file surfaceFieldValueI.H.

◆ is_weightedOp()

bool is_weightedOp ( ) const

inlineprotectednoexcept

True if the operation variant uses a weight-field.

Definition at line 82 of file surfaceFieldValueI.H.

◆ canWeight()

bool canWeight ( const Field< WeightType > & fld ) const

inlineprotected

True if field is non-empty on any processor.

Definition at line 51 of file surfaceFieldValueTemplates.C.

References fld, and Foam::returnReduceOr().

Here is the call graph for this function:

◆ update()

bool update ( )

protected

Update the surface and surface information as required.

Do nothing (and return false) if no update was required

Definition at line 582 of file surfaceFieldValue.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, error::IGNORE, Log, maxWarnings, Foam::name(), Foam::nl, refPtr< T >::ref(), Foam::returnReduce(), s, Foam::type(), error::WARN, and WarningInFunction.

Here is the call graph for this function:

◆ validField()

bool validField ( const word & fieldName ) const

protected

Return true if the field name is known and a valid type.

Definition at line 62 of file surfaceFieldValueTemplates.C.

◆ getFieldValues() [1/2]

tmp<Field<Type> > getFieldValues	(	const word &	fieldName,
		const bool	mandatory = `false`
	)		const

protected

Return field values by looking up field name.

◆ processSameTypeValues()

Type processSameTypeValues	(	const Field< Type > &	values,
		const vectorField &	Sf,
		const Field< WeightType > &	weightField
	)		const

protected

Apply the 'operation' to the values. Operation must preserve Type.

Definition at line 133 of file surfaceFieldValueTemplates.C.

References Foam::cmptMag(), Foam::component(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gMax(), Foam::gMin(), Foam::gSum(), Foam::mag(), n, Foam::expressions::Detail::nComponents(), returnReduce(), Foam::setComponent(), Foam::sqr(), Foam::sqrt(), Foam::HashTableOps::values(), and Foam::Zero.

Here is the call graph for this function:

◆ processValues() [1/5]

Type processValues	(	const Field< Type > &	values,
		const vectorField &	Sf,
		const Field< WeightType > &	weightField
	)		const

protected

Apply the 'operation' to the values. Wrapper around.

processSameTypeValues. See also template specialisation below.

Definition at line 314 of file surfaceFieldValueTemplates.C.

References Foam::HashTableOps::values().

Here is the call graph for this function:

◆ filterField() [1/4]

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

protected

Filter a surface field according to faceIds.

◆ filterField() [2/4]

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

protected

Filter a volume field according to faceIds.

◆ writeAll() [1/2]

label writeAll	(	const vectorField &	Sf,
		const Field< WeightType > &	weightField,
		const pointField &	points,
		const faceList &	faces
	)

protected

Templated helper function to output field values.

◆ writeValues()

bool writeValues	(	const word &	fieldName,
		const vectorField &	Sf,
		const Field< WeightType > &	weightField,
		const pointField &	points,
		const faceList &	faces
	)

protected

Templated helper function to output field values.

Definition at line 407 of file surfaceFieldValueTemplates.C.

References Foam::component(), Foam::endl(), Log, Foam::mag(), Foam::expressions::Detail::nComponents(), propsDict(), Foam::setComponent(), Foam::sqrt(), Foam::tab, and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ writeFileHeader()

void writeFileHeader ( Ostream & os )

protectedvirtual

Output file header information.

Definition at line 706 of file surfaceFieldValue.C.

References Foam::endl(), Foam::flatOutput(), Foam::nl, and Foam::tab.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "surfaceFieldValue" )

Declare type-name, virtual type (with debug switch)

◆ operator=()

void operator= ( const surfaceFieldValue & )

delete

No copy assignment.

◆ regionType()

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

inlinenoexcept

Return the region type.

Definition at line 90 of file surfaceFieldValueI.H.

◆ outputDir()

Foam::fileName outputDir ( ) const

inline

Return the output directory.

Definition at line 98 of file surfaceFieldValueI.H.

References Foam::name().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from fieldValue.

Definition at line 1137 of file surfaceFieldValue.C.

References Foam::ensightOutput::debug, error::DEFAULT, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::flatOutput(), surfaceWriter::formatOptions(), Enum< EnumType >::getOrDefault(), error::handlerNames, Foam::Info, keyType::LITERAL, IOobjectOption::MUST_READ, Foam::name(), sampledSurface::New(), surfaceWriter::New(), Foam::nl, fieldValue::read(), IOobjectOption::READ_IF_PRESENT, and Foam::type().

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the function-object results.

Reimplemented from fieldValue.

Definition at line 1327 of file surfaceFieldValue.C.

References Foam::abort(), UList< T >::empty(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), Log, UPstream::master(), Foam::nl, points, Foam::returnReduceOr(), s, UList< T >::size(), Foam::tab, update(), error::WARN, and fieldValue::write().

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 1499 of file surfaceFieldValue.C.

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 1508 of file surfaceFieldValue.C.

◆ processValues() [2/5]

Foam::scalar processValues	(	const Field< scalar > &	values,
		const vectorField &	Sf,
		const scalarField &	weightField
	)		const

Definition at line 753 of file surfaceFieldValue.C.

References Foam::clamp(), Foam::gSum(), Foam::mag(), n, Foam::neg(), Foam::pos0(), and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ processValues() [3/5]

Foam::vector processValues	(	const Field< vector > &	values,
		const vectorField &	Sf,
		const scalarField &	weightField
	)		const

Definition at line 827 of file surfaceFieldValue.C.

References Foam::clamp(), Foam::gSum(), Foam::mag(), n, Foam::pos0(), and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ weightingFactor() [3/9]

Foam::tmp<Foam::scalarField> weightingFactor	(	const Field< scalar > &	weightField,
		const bool	useMag
	)

Definition at line 915 of file surfaceFieldValue.C.

References Foam::mag().

Here is the call graph for this function:

◆ weightingFactor() [4/9]

Foam::tmp<Foam::scalarField> weightingFactor	(	const Field< scalar > &	weightField,
		const vectorField &	Sf,
		const bool	useMag
	)

if (returnReduceAnd(weightField.empty())) { // No weight field - revert to unweighted form? return tmp<scalarField>::New(Sf.size(), scalar(1)); }

Definition at line 933 of file surfaceFieldValue.C.

References Foam::mag().

Here is the call graph for this function:

◆ areaWeightingFactor() [2/5]

Foam::tmp<Foam::scalarField> areaWeightingFactor	(	const Field< scalar > &	weightField,
		const vectorField &	Sf,
		const bool	useMag
	)

if (returnReduceAnd(weightField.empty())) { // No weight field - revert to unweighted form return mag(Sf); }

Definition at line 961 of file surfaceFieldValue.C.

References Foam::mag().

Here is the call graph for this function:

◆ weightingFactor() [5/9]

Foam::tmp<Foam::scalarField> weightingFactor	(	const Field< vector > &	weightField,
		const vectorField &	Sf,
		const bool	useMag
	)

if (returnReduceAnd(weightField.empty())) { // No weight field - revert to unweighted form return tmp<scalarField>::New(Sf.size(), scalar(1)); }

Definition at line 988 of file surfaceFieldValue.C.

References Foam::mag(), tmp< T >::New(), Foam::normalised(), and UList< T >::size().

Here is the call graph for this function:

◆ areaWeightingFactor() [3/5]

Foam::tmp<Foam::scalarField> areaWeightingFactor	(	const Field< vector > &	weightField,
		const vectorField &	Sf,
		const bool	useMag
	)

if (returnReduceAnd(weightField.empty())) { // No weight field - revert to unweighted form return mag(Sf); }

Definition at line 1029 of file surfaceFieldValue.C.

References Foam::mag().

Here is the call graph for this function:

◆ processValues() [4/5]

scalar processValues	(	const Field< scalar > &	values,
		const vectorField &	Sf,
		const scalarField &	weightField
	)		const

Specialisation for scalar fields.

◆ processValues() [5/5]

vector processValues	(	const Field< vector > &	values,
		const vectorField &	Sf,
		const scalarField &	weightField
	)		const

Specialisation for vector fields.

◆ weightingFactor() [6/9]

tmp<scalarField> weightingFactor	(	const Field< scalar > &	weightField,
		const bool	useMag
	)

Specialisation for scalar - pass through.

◆ weightingFactor() [7/9]

tmp<scalarField> weightingFactor	(	const Field< scalar > &	weightField,
		const vectorField &	Sf,
		const bool	useMag
	)

Specialisation for scalar - pass through.

◆ areaWeightingFactor() [4/5]

tmp<scalarField> areaWeightingFactor	(	const Field< scalar > &	weightField,
		const vectorField &	Sf,
		const bool	useMag
	)

Specialisation for scalar - scalar * Area.

◆ weightingFactor() [8/9]

tmp<scalarField> weightingFactor	(	const Field< vector > &	weightField,
		const vectorField &	Sf,
		const bool	useMag
	)

Specialisation for vector - vector (dot) unit-normal.

◆ areaWeightingFactor() [5/5]

tmp<scalarField> areaWeightingFactor	(	const Field< vector > &	weightField,
		const vectorField &	Sf,
		const bool	useMag
	)

Specialisation for vector - vector (dot) Area.

◆ weightingFactor() [9/9]

Foam::tmp<Foam::scalarField> weightingFactor	(	const Field< WeightType > &	weightField,
		const bool	useMag
	)

Definition at line 36 of file surfaceFieldValueTemplates.C.

References Foam::mag().

Here is the call graph for this function:

◆ getFieldValues() [2/2]

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

Definition at line 82 of file surfaceFieldValueTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, fld, Foam::New(), and Foam::nl.

Here is the call graph for this function:

◆ writeAll() [2/2]

Foam::label writeAll	(	const vectorField &	Sf,
		const Field< WeightType > &	weightField,
		const pointField &	points,
		const faceList &	faces
	)

Definition at line 326 of file surfaceFieldValueTemplates.C.

References Foam::endl(), points, WarningInFunction, and writer().

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 536 of file surfaceFieldValueTemplates.C.

References field(), forAll, Foam::New(), and Foam::HashTableOps::values().

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 572 of file surfaceFieldValueTemplates.C.

References Foam::ensightOutput::debug, Foam::endl(), field(), forAll, Foam::New(), Foam::Pout, and Foam::HashTableOps::values().

Here is the call graph for this function:

Member Data Documentation

◆ regionTypeNames_

const Foam::Enum< Foam::functionObjects::fieldValues::surfaceFieldValue::regionTypes > regionTypeNames_

static

Region type names.

Definition at line 448 of file surfaceFieldValue.H.

◆ operationTypeNames_

const Foam::Enum< Foam::functionObjects::fieldValues::surfaceFieldValue::operationType > operationTypeNames_

static

Operation type names.

Definition at line 528 of file surfaceFieldValue.H.

◆ postOperationTypeNames_

const Foam::Enum< Foam::functionObjects::fieldValues::surfaceFieldValue::postOperationType > postOperationTypeNames_

static

Operation type names.

Definition at line 544 of file surfaceFieldValue.H.

◆ regionType_

regionTypes regionType_

protected

Region type.

Definition at line 592 of file surfaceFieldValue.H.

Referenced by surfaceFieldValue::obr(), and surfaceFieldValue::withSurfaceFields().

◆ operation_

operationType operation_

protected

Operation to apply to values.

Definition at line 597 of file surfaceFieldValue.H.

◆ postOperation_

postOperationType postOperation_

protected

Optional post-evaluation operation.

Definition at line 602 of file surfaceFieldValue.H.

◆ needsUpdate_

bool needsUpdate_

protected

Track if the surface needs an update.

Definition at line 607 of file surfaceFieldValue.H.

◆ writeArea_

bool writeArea_

protected

Optionally write the area of the surfaceFieldValue.

Definition at line 612 of file surfaceFieldValue.H.

◆ emptySurfaceError_

error::handlerTypes emptySurfaceError_

protected

Handling of empty surfaces (nFaces = 0). Default is Fatal.

Definition at line 617 of file surfaceFieldValue.H.

◆ selectionNames_

wordRes selectionNames_

protected

Extended selections.

Definition at line 622 of file surfaceFieldValue.H.

◆ weightFieldNames_

wordList weightFieldNames_

protected

Weight field name(s) - optional.

Definition at line 627 of file surfaceFieldValue.H.

◆ totalArea_

scalar totalArea_

protected

Total area of the surfaceFieldValue.

Definition at line 632 of file surfaceFieldValue.H.

◆ nFaces_

label nFaces_

protected

Global number of faces.

Definition at line 637 of file surfaceFieldValue.H.

◆ nWarnings_

unsigned nWarnings_

protected

Number of warnings emitted since the last valid update.

Definition at line 642 of file surfaceFieldValue.H.

◆ faceId_

labelList faceId_

protected

Local list of face IDs.

Definition at line 650 of file surfaceFieldValue.H.

◆ facePatchId_

labelList facePatchId_

protected

Local list of patch ID per face.

Definition at line 655 of file surfaceFieldValue.H.

◆ faceFlip_

boolList faceFlip_

protected

List representing the face flip map.

(false: use as-is, true: negate)

Definition at line 662 of file surfaceFieldValue.H.

◆ sampledPtr_

autoPtr<sampledSurface> sampledPtr_

protected

The sampledSurface (when operating on sampledSurface)

Definition at line 670 of file surfaceFieldValue.H.

Referenced by surfaceFieldValue::withSurfaceFields().

◆ surfaceWriterPtr_

autoPtr<surfaceWriter> surfaceWriterPtr_

protected

Surface writer.

Definition at line 675 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

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ regionTypes

◆ operationType

◆ postOperationType

Constructor & Destructor Documentation

◆ surfaceFieldValue() [1/3]

◆ surfaceFieldValue() [2/3]

◆ surfaceFieldValue() [3/3]

◆ ~surfaceFieldValue()

Member Function Documentation

◆ weightingFactor() [1/9]

◆ weightingFactor() [2/9]

◆ areaWeightingFactor() [1/5]

◆ obr()

◆ withSurfaceFields()

◆ withTopologicalMerge()

◆ faceId()

◆ facePatch()

◆ faceFlip()

◆ usesSf()

◆ is_magOp()

◆ is_weightedOp()

◆ canWeight()

◆ update()

◆ validField()

◆ getFieldValues() [1/2]

◆ processSameTypeValues()

◆ processValues() [1/5]

◆ filterField() [1/4]

◆ filterField() [2/4]

◆ writeAll() [1/2]

◆ writeValues()

◆ writeFileHeader()

◆ TypeName()

◆ operator=()

◆ regionType()

◆ outputDir()

◆ read()

◆ write()

◆ updateMesh()

◆ movePoints()

◆ processValues() [2/5]

◆ processValues() [3/5]

◆ weightingFactor() [3/9]

◆ weightingFactor() [4/9]

◆ areaWeightingFactor() [2/5]

◆ weightingFactor() [5/9]

◆ areaWeightingFactor() [3/5]

◆ processValues() [4/5]

◆ processValues() [5/5]

◆ weightingFactor() [6/9]

◆ weightingFactor() [7/9]

◆ areaWeightingFactor() [4/5]

◆ weightingFactor() [8/9]

◆ areaWeightingFactor() [5/5]

◆ weightingFactor() [9/9]

◆ getFieldValues() [2/2]

◆ writeAll() [2/2]

◆ filterField() [3/4]

◆ filterField() [4/4]

Member Data Documentation

◆ regionTypeNames_

◆ operationTypeNames_

◆ postOperationTypeNames_

◆ regionType_

◆ operation_

◆ postOperation_

◆ needsUpdate_

◆ writeArea_

◆ emptySurfaceError_

◆ selectionNames_

◆ weightFieldNames_