zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

functionObjects: Update documentation

Browse Source
This commit is contained in:
Henry Weller
2016-07-09 22:08:11 +01:00
parent 08bd802b42
commit 6a8bac9235
11 changed files with 63 additions and 557 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
src/functionObjects/field/fieldValues/controlDict
View File

@ -1,129 +0,0 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \\ / O peration | Version: dev |
| \\ / A nd | Web: www.OpenFOAM.org |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
{
version 2.0;
format ascii;
class dictionary;
object controlDict;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
application icoFoam;
startFrom startTime;
startTime 0;
stopAt endTime;
endTime 0.5;
deltaT 0.005;
writeControl timeStep;
writeInterval 20;
purgeWrite 0;
writeFormat ascii;
writePrecision 6;
writeCompression off;
timeFormat general;
timePrecision 6;
runTimeModifiable true;
functions
{
faceObj1
{
type surfaceRegion;
libs ("libfieldFunctionObjects.so");
enabled true;
writeControl writeTime;
// Output to log&file (true) or to file only
log true;
// Output field values as well
writeFields true;
// Type of region: patch/faceZone/sampledSurface
regionType patch;
// if patch or faceZone: name of patch or faceZone
name movingWall;
//// if sampledSurface: dictionary with a sampledSurface
//// Note: will not sample surface fields.
//sampledSurfaceDict
//{
// // Sampling on triSurface
// type sampledTriSurfaceMesh;
// surface integrationPlane.stl;
// regionType cells; // sample cells or boundaryFaces
// interpolate true;
//}
// Operation: areaAverage/sum/weightedAverage ...
operation areaAverage;
fields
(
p
phi // surface fields not supported for sampledSurface
U
);
}
faceObj2
{
type surfaceRegion;
libs ("libfieldFunctionObjects.so");
enabled true;
writeControl writeTime;
log true;
writeFields true;
regionType faceZone;
name f0;
operation sum;
fields
(
phi
);
}
cellObj1
{
type volRegion;
libs ("libfieldFunctionObjects.so");
enabled true;
writeControl writeTime;
log true;
writeFields true;
regionType cellZone;
name c0;
operation volAverage;
fields
(
p
U
);
}
}
// ************************************************************************* //

33
src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H
View File

@ -37,20 +37,47 @@ Description
For example, to calculate the volumetric or mass flux across a patch,
apply the 'sum' operator to the flux field (typically \c phi)
Example of function object specification:
Examples of function object specification:
\verbatim
movingWallPatch
{
type surfaceRegion;
libs ("libfieldFunctionObjects.so");
log true;
writeControl writeTime;
writeFields true;
regionType patch;
name movingWall;
operation areaAverage;
fields
(
p
phi
U
);
}
surfaceRegion1
{
type surfaceRegion;
libs ("libfieldFunctionObjects.so");
...
log yes;
log true;
writeControl writeTime;
writeFields true;
surfaceFormat none;
regionType faceZone;
name f0;
operation sum;
weightField alpha1;
fields
(
p

6
src/functionObjects/field/fieldValues/volRegion/volRegion.H
View File

@ -41,13 +41,17 @@ Description
{
type volRegion;
libs ("libfieldFunctionObjects.so");
...
log true;
writeControl writeTime;
writeFields true;
regionType cellZone;
name c0;
operation volAverage;
weightField alpha1;
fields
(
p