162 #ifndef functionObjects_surfaceFieldValue_H 163 #define functionObjects_surfaceFieldValue_H 173 class sampledSurface;
176 namespace functionObjects
178 namespace fieldValues
185 class surfaceFieldValue
220 weightedAreaIntegrate,
237 void setFaceZoneFaces();
240 void setPatchFaces();
243 void sampledSurfaceFaces(
const dictionary&);
246 void combineMeshGeometry
253 void combineSurfaceGeometry
260 scalar totalArea()
const;
330 const word& fieldName,
331 const bool mustGet =
false,
332 const bool applyOrientation =
false 409 const word& fieldName,
419 const bool applyOrientation
427 const bool applyOrientation
434 virtual bool write();
labelList faceSign_
List of +1/-1 representing face flip map.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
virtual ~surfaceFieldValue()
Destructor.
A class for handling file names.
surfaceFieldValue(const word &name, const Time &runTime, const dictionary &dict)
Construct from name, Time and dictionary.
const labelList & faceSign() const
Return the list of +1/-1 representing face flip map.
void initialise(const dictionary &dict)
Initialise, e.g. face addressing.
const word & name() const
Return the name of this functionObject.
A list of keyword definitions, which are a keyword followed by any number of values (e...
dimensioned< Type > max(const dimensioned< Type > &, const dimensioned< Type > &)
fileName outputDir() const
Return the output directory.
virtual bool write()
Calculate and write.
static const NamedEnum< operationType, 17 > operationTypeNames_
Operation type names.
regionTypes
region type enumeration
Generic GeometricField class.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
const regionTypes & regionType() const
Return the region type.
dimensioned< Type > sum(const DimensionedField< Type, GeoMesh > &df)
TypeName("surfaceFieldValue")
Run-time type information.
operationType
Operation type enumeration.
scalar totalArea_
Total area of the surfaceFieldValue.
autoPtr< sampledSurface > surfacePtr_
Underlying sampledSurface.
labelList faceId_
Local list of face IDs.
vectorField pointField
pointField is a vectorField.
Pre-declare SubField and related Field type.
regionTypes regionType_
region type
A class for handling words, derived from string.
labelList facePatchId_
Local list of patch ID per face.
label orientedFieldsStart_
Start index of fields that require application of flipMap.
bool orientWeightField_
Flag to indicate if flipMap should be applied to the weight field.
const dictionary & dict() const
Return the reference to the construction dictionary.
bool validField(const word &fieldName) const
Return true if the field name is valid.
Type processValues(const Field< Type > &values, const vectorField &Sf, const scalarField &weightField) const
Apply the 'operation' to the values. Wrapper around.
List< label > labelList
A List of labels.
const labelList & facePatch() const
Return the local list of patch ID per face.
tmp< Field< Type > > getFieldValues(const word &fieldName, const bool mustGet=false, const bool applyOrientation=false) const
Return field values by looking up field name.
word weightFieldName_
Weight field name - optional.
tmp< Field< Type > > filterField(const GeometricField< Type, fvsPatchField, surfaceMesh > &field, const bool applyOrientation) const
Filter a surface field according to faceIds.
Type processSameTypeValues(const Field< Type > &values, const vectorField &Sf, const scalarField &weightField) const
Apply the 'operation' to the values. Operation has to.
dimensioned< Type > min(const dimensioned< Type > &, const dimensioned< Type > &)
const labelList & faceId() const
Return the local list of face IDs.
autoPtr< surfaceWriter > surfaceWriterPtr_
Surface writer.
label nFaces_
Global number of faces.
virtual bool read(const dictionary &)
Read from dictionary.
bool writeValues(const word &fieldName, const scalarField &weightField, const bool orient)
Templated helper function to output field values.
tmp< GeometricField< Type, fvPatchField, volMesh > > average(const GeometricField< Type, fvsPatchField, surfaceMesh > &ssf)
Area-weighted average a surfaceField creating a volField.
operationType operation_
Operation to apply to values.
static const NamedEnum< regionTypes, 3 > regionTypeNames_
region type names
bool writeArea_
Optionally write the area of the surfaceFieldValue.
A class for managing temporary objects.
Registry of regIOobjects.
virtual void writeFileHeader(const label i)
Output file header information.
dimensioned< scalar > sumMag(const DimensionedField< Type, GeoMesh > &df)
scalar scaleFactor_
Scale factor - optional.