This function object provides a 'face source' 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. More...

Inheritance diagram for faceSource:

[legend]

Collaboration diagram for faceSource:

[legend]

Public Types
enum	sourceType { stFaceZone, stPatch, stSampledSurface }
	Source type enumeration. More...

enum	operationType { opNone, opSum, opSumMag, opSumDirection, opSumDirectionBalance, opAverage, opWeightedAverage, opAreaAverage, opWeightedAreaAverage, opAreaIntegrate, opMin, opMax, opCoV, opAreaNormalAverage, opAreaNormalIntegrate }
	Operation type enumeration. More...

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

	faceSource (const word &name, const objectRegistry &obr, const dictionary &dict, const bool loadFromFiles=false)
	Construct from components. More...

virtual	~faceSource ()
	Destructor. More...

const sourceType &	source () const
	Return the source 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...

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

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

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

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

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

template<>
Foam::scalar	processValues (const Field< scalar > &values, const vectorField &Sf, const scalarField &weightField) const
	Specialisation of processing scalars. More...

template<>
Foam::vector	processValues (const Field< vector > &values, const vectorField &Sf, const scalarField &weightField) const
	Specialisation of processing vectors. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	setFieldValues (const word &fieldName, const bool mustGet, const bool applyOrientation) const

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

template<class Type >
Foam::tmp< Foam::Field< Type > >	filterField (const GeometricField< Type, fvsPatchField, surfaceMesh > &field, const bool applyOrientation) 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, const bool loadFromFiles),(name, obr, dict, loadFromFiles))

	fieldValue (const word &name, const objectRegistry &obr, const dictionary &dict, const word &valueType, const bool loadFromFiles=false)
	Construct from components. More...

virtual	~fieldValue ()
	Destructor. More...

const word &	name () const
	Return the name of the geometric source. More...

const objectRegistry &	obr () const
	Return the reference to the object registry. More...

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

bool	active () const
	Return the active flag. More...

const Switch &	log () const
	Return the switch to send output to Info as well as to file. More...

const word &	sourceName () const
	Return the source name. More...

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

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

const fvMesh &	mesh () const
	Helper function to return the reference to the mesh. More...

virtual void	execute ()
	Execute. More...

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

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

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

virtual void	movePoints (const polyMesh &)
	Move points. More...

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...

Public Member Functions inherited from functionObjectState
	functionObjectState (const objectRegistry &obr, const word &name)
	Construct from components. More...

virtual	~functionObjectState ()
	Destructor. More...

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

bool	active () const
	Return the active flag. More...

const IOdictionary &	stateDict () const
	Return access to the state dictionary. More...

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

template<class Type >
bool	setActive ()
	Set the active status by querying objectRegistry type. More...

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

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

template<class Type >
void	getProperty (const word &entryName, Type &value) const
	Retrieve generic property. 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=pTraits< Type >::zero) const
	Retrieve generic property from named object. More...

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

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

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=pTraits< Type >::zero) const
	Retrieve result. More...

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

template<class Type >
void	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Retrieve result from named object. 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...

List< word >	objectResultEntries () const
	Retrieve the result entries. More...

List< word >	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

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

	functionObjectFile (const objectRegistry &obr, const word &prefix, const word &fileName, const dictionary &dict)
	Construct from components and read options from dictionary. More...

virtual	~functionObjectFile ()
	Destructor. More...

void	read (const dictionary &dict)
	Read. More...

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

bool	writeToFile () const
	Return true if can write to file. 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...

Static Public Attributes
static const NamedEnum< sourceType, 3 >	sourceTypeNames_
	Source type names. More...

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

Static Public Attributes inherited from functionObjectFile
static const word	outputPrefix = "postProcessing"
	Directory prefix. More...

static label	addChars = 7
	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 > >	setFieldValues (const word &fieldName, const bool mustGet=false, const bool applyOrientation=false) const
	Return field values by looking up field name. More...

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

template<class Type >
Type	processValues (const Field< Type > &values, const vectorField &Sf, const scalarField &weightField) const
	Apply the 'operation' to the values. Wrapper around. More...

virtual void	writeFileHeader (Ostream &os) const
	Output file header information. More...

Protected Member Functions inherited from functionObjectState
	functionObjectState (const functionObjectState &)
	Disallow default bitwise copy construct. More...

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

Protected Member Functions inherited from functionObjectFile
virtual void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

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

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

virtual autoPtr< OFstream >	createFile (const word &name) const
	Return an autoPtr to a new file. More...

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

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

	functionObjectFile (const functionObjectFile &)
	Disallow default bitwise copy construct. More...

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

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

sourceType	source_
	Source type. More...

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

word	weightFieldName_
	Weight field name - optional. More...

bool	orientWeightField_
	Flag to indicate if flipMap should be applied to the weight field. More...

label	orientedFieldsStart_
	Start index of fields that require application of flipMap. More...

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

bool	writeArea_
	Optionally write the area of the faceSource. 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
const objectRegistry &	obr_
	Database this class is registered to. More...

dictionary	dict_
	Construction dictionary. More...

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

word	sourceName_
	Name of source object. More...

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

Switch	valueOutput_
	Output field values flag. More...

scalar	scaleFactor_
	Scale factor - optional. More...

Protected Attributes inherited from functionObjectState
const word	name_
	Name of model. More...

bool	active_
	Flag to indicate whether the object is active. More...

IOdictionary &	stateDict_
	Reference to the state dictionary. More...

Protected Attributes inherited from functionObjectFile
bool	writeToFile_
	Flag to enable/disable writing to file. More...

Private Member Functions
void	setFaceZoneFaces ()
	Set faces to evaluate based on a face zone. More...

void	setPatchFaces ()
	Set faces to evaluate based on a patch. More...

void	sampledSurfaceFaces (const dictionary &)
	Set faces according to sampledSurface. More...

void	combineMeshGeometry (faceList &faces, pointField &points) const
	Combine mesh faces and points from multiple processors. More...

void	combineSurfaceGeometry (faceList &faces, pointField &points) const
	Combine surface faces and points from multiple processors. More...

scalar	totalArea () const
	Calculate and return total area of the faceSource: sum(magSf) 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 loadFromFiles=false, const bool output=true)
	Return a reference to the selected fieldValue. More...

Detailed Description

This function object provides a 'face source' 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)

Example of function object specification:

faceSource1
{
    type            faceSource;
    functionObjectLibs ("libfieldFunctionObjects.so");
    ...
    log             yes;
    valueOutput     true;
    surfaceFormat   none;
    source          faceZone;
    sourceName      f0;
    operation       sum;
    weightField     alpha1;
    fields
    (
        p
        phi
        U
    );
}

Function object usage

Property	Description	Required	Default value
`type`	type name: faceSource	yes
`log`	write data to standard output	no	no
`valueOutput`	write the output values	yes
`writeArea`	Write the area of the faceSource	no
`surfaceFormat`	output value format	no
`source`	face source: see below	yes
`sourceName`	name of face source if required	no
`operation`	operation to perform	yes
`weightField`	name of field to apply weighting	no
`orientedWeightField`	name of oriented field to apply weighting	no
`scaleFactor`	scale factor	no	1
`fields`	list of fields to operate on	yes
`orientedFields`	list of oriented fields to operate on	no

Where source is defined by

faceZone	:	requires a 'sourceName' entry to specify the faceZone
patch	:	requires a 'sourceName' 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
average	:	ensemble average
weightedAverage	:	weighted average
areaAverage	:	area weighted average
weightedAreaAverage	:	weighted area average
areaIntegrate	:	area integral
min	:	minimum
max	:	maximum
CoV	:	coefficient of variation: standard deviation/mean
areaNormalAverage	:	area weighted average in face normal direction
areaNormalIntegrate	:	area weighted integral in face normal directon

Note

The values reported by the areaNormalAverage and areaNormalIntegrate operations are written as the first component of a field with the same rank as the input field.
faces on empty patches get ignored
if the field is a volField the faceZone can only consist of boundary faces
the `oriented' entries relate to mesh-oriented fields, such as the flux, phi. These fields will be oriented according to the face normals.
using sampledSurfaces:
- not available for surface fields
- if interpolate=true they use interpolationCellPoint otherwise they use cell values
- each triangle in sampledSurface is logically only in one cell so interpolation will be wrong when triangles are larger than cells. This can only happen for sampling on a triSurfaceMesh
- take care when using isoSurfaces - these might have duplicate triangles and so integration might be wrong

See also: Foam::fieldValues Foam::functionObject Foam::OutputFilterFunctionObject

Source files

Definition at line 303 of file faceSource.H.

Member Enumeration Documentation

◆ sourceType

enum sourceType

Source type enumeration.

Enumerator
stFaceZone
stPatch
stSampledSurface

Definition at line 313 of file faceSource.H.

◆ operationType

enum operationType

Operation type enumeration.

Enumerator
opNone
opSum
opSumMag
opSumDirection
opSumDirectionBalance
opAverage
opWeightedAverage
opAreaAverage
opWeightedAreaAverage
opAreaIntegrate
opMin
opMax
opCoV
opAreaNormalAverage
opAreaNormalIntegrate

Definition at line 325 of file faceSource.H.

Constructor & Destructor Documentation

◆ faceSource()

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

Construct from components.

Definition at line 611 of file faceSource.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~faceSource()

~faceSource ( )

virtual

Destructor.

Definition at line 641 of file faceSource.C.

Member Function Documentation

◆ setFaceZoneFaces()

void setFaceZoneFaces ( )

private

Set faces to evaluate based on a face zone.

Definition at line 87 of file faceSource.C.

References DynamicList::append(), polyMesh::boundaryMesh(), Foam::endl(), Foam::exit(), faceSource::faceId(), faceSource::faceId_, faceSource::facePatchId_, faceSource::faceSign_, polyMesh::faceZones(), Foam::FatalError, FatalErrorInFunction, ZoneMesh::findZoneID(), faceZone::flipMap(), forAll, fieldValue::mesh(), functionObjectState::name_, ZoneMesh::names(), faceSource::nFaces_, Foam::nl, Foam::Pout, Foam::returnReduce(), List::size(), faceSource::source_, fieldValue::sourceName_, faceSource::sourceTypeNames_, polyPatch::start(), List::transfer(), Foam::type(), polyPatch::whichFace(), and polyBoundaryMesh::whichPatch().

Here is the call graph for this function:

◆ setPatchFaces()

void setPatchFaces ( )

private

Set faces to evaluate based on a patch.

Definition at line 172 of file faceSource.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, mesh, Foam::nl, patchId(), Foam::returnReduce(), and Foam::type().

Here is the call graph for this function:

◆ sampledSurfaceFaces()

void sampledSurfaceFaces ( const dictionary & dict )

private

Set faces according to sampledSurface.

Definition at line 209 of file faceSource.C.

References dict, mesh, sampledSurface::New(), and Foam::returnReduce().

Here is the call graph for this function:

◆ combineMeshGeometry()

void combineMeshGeometry	(	faceList &	faces,
		pointField &	points
	)		const

private

Combine mesh faces and points from multiple processors.

Definition at line 223 of file faceSource.C.

References Foam::DelaunayMeshTools::allPoints(), Foam::endl(), f(), forAll, Pstream::gatherList(), Foam::inplaceRenumber(), PrimitivePatch< Face, FaceList, PointField, PointType >::localFaces(), PrimitivePatch< Face, FaceList, PointField, PointType >::localPoints(), Foam::mergePoints(), mesh, UPstream::myProcNo(), nPoints, UPstream::nProcs(), points, Foam::Pout, List::setSize(), and List::size().

Here is the call graph for this function:

◆ combineSurfaceGeometry()

void combineSurfaceGeometry	(	faceList &	faces,
		pointField &	points
	)		const

private

Combine surface faces and points from multiple processors.

Definition at line 344 of file faceSource.C.

References Foam::e, PatchTools::gatherAndMerge(), mesh, UPstream::parRun(), points, and s().

Here is the call graph for this function:

◆ totalArea()

Foam::scalar totalArea ( ) const

private

Calculate and return total area of the faceSource: sum(magSf)

Definition at line 382 of file faceSource.C.

References Foam::gSum(), and mesh.

Here is the call graph for this function:

◆ initialise()

void initialise ( const dictionary & dict )

protected

Initialise, e.g. face addressing.

Definition at line 401 of file faceSource.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, surfaceWriter::New(), Foam::nl, List::size(), Foam::type(), 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 valid.

Definition at line 35 of file faceSourceTemplates.C.

References objectRegistry::foundObject(), fieldValue::obr_, sf(), faceSource::source_, and faceSource::stSampledSurface.

Here is the call graph for this function:

◆ setFieldValues() [1/2]

tmp<Field<Type> > setFieldValues	(	const word &	fieldName,
		const bool	mustGet = `false`,
		const bool	applyOrientation = `false`
	)		const

protected

Return field values by looking up field name.

◆ processSameTypeValues()

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

protected

Apply the 'operation' to the values. Operation has to.

preserve Type.

Definition at line 124 of file faceSourceTemplates.C.

References Foam::cmptMag(), Foam::component(), Field::component(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gMax(), Foam::gMin(), Foam::gSum(), Foam::mag(), n, Foam::returnReduce(), Foam::setComponent(), Foam::sqr(), and Foam::sqrt().

Here is the call graph for this function:

◆ processValues() [1/3]

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

protected

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

processSameTypeValues. See also template specialisation below.

Definition at line 261 of file faceSourceTemplates.C.

◆ writeFileHeader()

void writeFileHeader ( Ostream & os ) const

protectedvirtual

Output file header information.

Definition at line 508 of file faceSource.C.

References Foam::endl(), forAll, and Foam::tab.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "faceSource" )

Run-time type information.

◆ source()

const Foam::fieldValues::faceSource::sourceType & source ( ) const

inline

Return the source type.

Definition at line 31 of file faceSourceI.H.

References faceSource::source_.

◆ faceId()

const Foam::labelList & faceId ( ) const

inline

Return the local list of face IDs.

Definition at line 38 of file faceSourceI.H.

Referenced by faceSource::setFaceZoneFaces().

Here is the caller graph for this function:

◆ facePatch()

const Foam::labelList & facePatch ( ) const

inline

Return the local list of patch ID per face.

Definition at line 45 of file faceSourceI.H.

◆ faceSign()

const Foam::labelList & faceSign ( ) const

inline

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

Definition at line 52 of file faceSourceI.H.

◆ read()

void read ( const dictionary & dict )

virtual

Read from dictionary.

Reimplemented from fieldValue.

Definition at line 647 of file faceSource.C.

References dict, and fieldValue::read().

Here is the call graph for this function:

◆ write()

void write ( )

virtual

Calculate and write.

Reimplemented from fieldValue.

Definition at line 659 of file faceSource.C.

References Foam::endl(), forAll, Foam::Info, Foam::tab, WarningInFunction, and fieldValue::write().

Here is the call graph for this function:

◆ writeValues()

bool writeValues	(	const word &	fieldName,
		const scalarField &	weightField,
		const bool	orient
	)

Templated helper function to output field values.

Definition at line 276 of file faceSourceTemplates.C.

References Foam::endl(), Foam::Info, UPstream::master(), mesh, points, 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 bool	applyOrientation
	)		const

Filter a surface field according to faceIds.

◆ filterField() [2/4]

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

Filter a volume field according to faceIds.

◆ processValues() [2/3]

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

Specialisation of processing scalars.

Definition at line 534 of file faceSource.C.

References Foam::gSum(), Foam::mag(), n, Foam::neg(), and Foam::pos().

Here is the call graph for this function:

◆ processValues() [3/3]

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

Specialisation of processing vectors.

Definition at line 565 of file faceSource.C.

References Foam::gSum(), Foam::mag(), n, and Foam::pos().

Here is the call graph for this function:

◆ setFieldValues() [2/2]

Foam::tmp<Foam::Field<Type> > setFieldValues	(	const word &	fieldName,
		const bool	mustGet,
		const bool	applyOrientation
	)		const

Definition at line 55 of file faceSourceTemplates.C.

References Foam::abort(), f(), Foam::FatalError, FatalErrorInFunction, fld(), forAll, Foam::interpolate(), sf(), and List::size().

Here is the call graph for this function:

◆ filterField() [3/4]

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

Definition at line 360 of file faceSourceTemplates.C.

References Foam::abort(), GeometricField::boundaryField(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::nl, 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 bool	applyOrientation
	)		const

Definition at line 401 of file faceSourceTemplates.C.

References GeometricField::boundaryField(), and forAll.

Here is the call graph for this function:

Field Documentation

◆ sourceTypeNames_

const Foam::NamedEnum< Foam::fieldValues::faceSource::sourceType, 3 > sourceTypeNames_

static

Source type names.

Definition at line 321 of file faceSource.H.

Referenced by faceSource::setFaceZoneFaces().

◆ operationTypeNames_

const Foam::NamedEnum< Foam::fieldValues::faceSource::operationType, 15 > operationTypeNames_

static

Operation type names.

Definition at line 345 of file faceSource.H.

◆ surfaceWriterPtr_

autoPtr<surfaceWriter> surfaceWriterPtr_

protected

Surface writer.

Definition at line 384 of file faceSource.H.

◆ source_

sourceType source_

protected

Source type.

Definition at line 387 of file faceSource.H.

Referenced by faceSource::setFaceZoneFaces(), faceSource::source(), and faceSource::validField().

◆ operation_

operationType operation_

protected

Operation to apply to values.

Definition at line 390 of file faceSource.H.

◆ weightFieldName_

word weightFieldName_

protected

Weight field name - optional.

Definition at line 393 of file faceSource.H.

◆ orientWeightField_

bool orientWeightField_

protected

Flag to indicate if flipMap should be applied to the weight field.

Definition at line 396 of file faceSource.H.

◆ orientedFieldsStart_

label orientedFieldsStart_

protected

Start index of fields that require application of flipMap.

Definition at line 399 of file faceSource.H.

◆ totalArea_

scalar totalArea_

protected

Total area of the faceSource.

Definition at line 402 of file faceSource.H.

◆ writeArea_

bool writeArea_

protected

Optionally write the area of the faceSource.

Definition at line 405 of file faceSource.H.

◆ nFaces_

label nFaces_

protected

Global number of faces.

Definition at line 408 of file faceSource.H.

Referenced by faceSource::setFaceZoneFaces().

◆ faceId_

labelList faceId_

protected

Local list of face IDs.

Definition at line 414 of file faceSource.H.

Referenced by faceSource::setFaceZoneFaces().

◆ facePatchId_

labelList facePatchId_

protected

Local list of patch ID per face.

Definition at line 417 of file faceSource.H.

Referenced by faceSource::setFaceZoneFaces().

◆ faceSign_

labelList faceSign_

protected

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

(1 use as is, -1 negate)

Definition at line 421 of file faceSource.H.

Referenced by faceSource::setFaceZoneFaces().

◆ surfacePtr_

autoPtr<sampledSurface> surfacePtr_

protected

Underlying sampledSurface.

Definition at line 427 of file faceSource.H.

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

src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H
src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.C
src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSourceI.H
src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSourceTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ sourceType

◆ operationType

Constructor & Destructor Documentation

◆ faceSource()

◆ ~faceSource()

Member Function Documentation

◆ setFaceZoneFaces()

◆ setPatchFaces()

◆ sampledSurfaceFaces()

◆ combineMeshGeometry()

◆ combineSurfaceGeometry()

◆ totalArea()

◆ initialise()

◆ validField()

◆ setFieldValues() [1/2]

◆ processSameTypeValues()

◆ processValues() [1/3]

◆ writeFileHeader()

◆ TypeName()

◆ source()

◆ faceId()

◆ facePatch()

◆ faceSign()

◆ read()

◆ write()

◆ writeValues()

◆ filterField() [1/4]

◆ filterField() [2/4]

◆ processValues() [2/3]

◆ processValues() [3/3]

◆ setFieldValues() [2/2]

◆ filterField() [3/4]

◆ filterField() [4/4]

Field Documentation

◆ sourceTypeNames_

◆ operationTypeNames_

◆ surfaceWriterPtr_

◆ source_

◆ operation_

◆ weightFieldName_

◆ orientWeightField_

◆ orientedFieldsStart_

◆ totalArea_

◆ writeArea_

◆ nFaces_

◆ faceId_

◆ facePatchId_

◆ faceSign_

◆ surfacePtr_