#includeFunc, #includeModel, #includeConstraint: Changed entry renaming option to "name"

This is a more intuitive keyword than "funcName" or "entryName". A
function object's name and corresponding output directory can now be
renamed as follows:

    #includeFunc patchAverage
    (
        name=cylinderT, // <-- was funcName=... or entryName=...
        region=fluid,
        patch=fluid_to_solid,
        field=T
    )

Some packaged functions previously relied on a "name" argument that
related to an aspect of the function; e.g., the name of the faceZone
used by the faceZoneFlowRate function. These have been disambiguated.
This has also made them consistent with the preferred input syntax of
the underlying function objects.

Examples of the changed #includeFunc entries are shown below:

    #includeFunc faceZoneAverage
    (
        faceZone=f0, // <-- was name=f0
        U
    )

    #includeFunc faceZoneFlowRate
    (
        faceZone=f0 // <-- was name=f0
    )

    #includeFunc populationBalanceSizeDistribution
    (
        populationBalance=bubbles,
        regionType=cellZone,
        cellZone=injection, // <-- was name=injection
        functionType=volumeDensity,
        coordinateType=diameter,
        normalise=yes
    )

    #includeFunc triSurfaceAverage
    (
        triSurface=mid.obj, // <-- was name=mid.obj
        p
    )

    #includeFunc triSurfaceVolumetricFlowRate
    (
        triSurface=mid.obj // <-- was name=mid.obj
    )

    #includeFunc uniform
    (
        fieldType=volScalarField,
        fieldName=alpha, // <-- was name=alpha
        dimensions=[0 0 0 0 0 0 0],
        value=0.2
    )
This commit is contained in:
Will Bainbridge
2023-02-01 11:18:58 +00:00
parent 574165dc13
commit dc85d509b0
43 changed files with 109 additions and 103 deletions

View File

@ -14,7 +14,7 @@ type uniform;
libs ("libfieldFunctionObjects.so");
fieldType <fieldType>;
name <name>;
field <fieldName>;
dimensions <dimensions>;
value <value>;

View File

@ -31,7 +31,7 @@ weightType numberConcentration; // volumeConcentration,
// numberConcentration
regionType all; // cellZone
// defaults to all
name cellZoneName; // relevant for regionType all
cellZone cellZoneName; // relevant for regionType all
setFormat raw;

View File

@ -10,7 +10,7 @@ Description
\*---------------------------------------------------------------------------*/
name <faceZoneName>;
faceZone <faceZoneName>;
fields (<fieldNames>);

View File

@ -12,7 +12,7 @@ Description
\*---------------------------------------------------------------------------*/
name <faceZoneName>;
faceZone <faceZoneName>;
fields (phi);

View File

@ -8,6 +8,6 @@
#includeEtc "caseDicts/postProcessing/surfaceFieldValue/surfaceValue.cfg"
regionType faceZone;
regionType faceZone;
// ************************************************************************* //

View File

@ -9,6 +9,5 @@
#includeEtc "caseDicts/postProcessing/surfaceFieldValue/surfaceValue.cfg"
regionType patch;
name $patch;
// ************************************************************************* //

View File

@ -12,7 +12,7 @@ Description
\*---------------------------------------------------------------------------*/
name <triSurfaceFileName>;
triSurface <triSurfaceFileName>;
fields (<fieldNames>);

View File

@ -13,7 +13,7 @@ regionType sampledSurface;
sampledSurfaceDict
{
type triSurfaceMesh;
surface $name;
surface $triSurface;
source cells;
interpolate true;
}

View File

@ -13,7 +13,7 @@ Description
\*---------------------------------------------------------------------------*/
name <triSurfaceFileName>;
triSurface <triSurfaceFileName>;
fields (U);

View File

@ -528,6 +528,8 @@ bool Foam::readConfigFile
namedArgs[i].first() != "field"
&& namedArgs[i].first() != "fields"
&& namedArgs[i].first() != "objects"
&& namedArgs[i].first() != "funcName"
&& namedArgs[i].first() != "name"
)
{
const Pair<word> dAk(dictAndKeyword(namedArgs[i].first()));
@ -547,16 +549,21 @@ bool Foam::readConfigFile
}
// Set the name of the entry to that specified by the optional
// entryName argument otherwise automatically generate a unique name
// name argument otherwise automatically generate a unique name
// from the type and arguments
const word entryName
(
funcDict.lookupOrDefaultBackwardsCompatible
word entryName(string::validate<word>(argString));
forAll(namedArgs, i)
{
if
(
{"entryName", "funcName"},
string::validate<word>(argString)
namedArgs[i].first() == "funcName"
|| namedArgs[i].first() == "name"
)
);
{
entryName = namedArgs[i].second();
entryName.strip(" \n");
}
}
// Check for anything in the configuration that has not been set
List<Tuple2<word, string>> unsetArgs = unsetConfigEntries(funcDict);

View File

@ -167,7 +167,7 @@ fieldsOperationsFunctions
#includeFunc uniform
(
fieldType=volScalarField,
name=mag(smallU),
field=mag(smallU),
dimensions=[0 1 -1 0 0 0 0],
value=1e-16
)
@ -182,7 +182,7 @@ fieldsOperationsFunctions
#includeFunc uniform
(
fieldType=volScalarField,
name=Ta,
field=Ta,
dimensions=[0 0 0 1 0 0 0],
value=297
)
@ -314,7 +314,7 @@ probesFunctions
#includeFunc uniform
(
fieldType=volScalarField,
name=alpha.dummy,
field=alpha.dummy,
dimensions=[0 0 0 0 0 0 0],
value=0.2
)
@ -394,13 +394,13 @@ surfaceFieldValueFunctions
#includeFunc patchDifference(patch1=inlet, patch2=outlet, p)
#includeFunc faceZoneAverage(name=f0, U)
#includeFunc faceZoneAverage(faceZone=f0, U)
#includeFunc faceZoneFlowRate(name=f0)
#includeFunc faceZoneFlowRate(faceZone=f0)
#includeFunc triSurfaceAverage(name=mid.obj, p)
#includeFunc triSurfaceAverage(triSurface=mid.obj, p)
#includeFunc triSurfaceVolumetricFlowRate(name=mid.obj)
#includeFunc triSurfaceVolumetricFlowRate(triSurface=mid.obj)
#includeFunc triSurfaceDifference
(

View File

@ -48,7 +48,7 @@ functions
{
#includeFunc patchFlowRate(patch=lowerInlet, cloud:massFlux)
#includeFunc patchFlowRate(patch=upperInlet, cloud:massFlux)
#includeFunc faceZoneFlowRate(name=mid, cloud:massFlux)
#includeFunc faceZoneFlowRate(faceZone=mid, cloud:massFlux)
#includeFunc patchFlowRate(patch=outlet, cloud:massFlux)
}

View File

@ -63,14 +63,14 @@ functions
{
#includeFunc patchAverage
(
entryName=cylinderT,
name=cylinderT,
region=fluid,
patch=fluid_to_solid,
field=T
)
#includeFunc patchAverage
(
entryName=inletU,
name=inletU,
region=fluid,
patch=inlet,
field=U

View File

@ -61,14 +61,14 @@ functions
{
#includeFunc patchAverage
(
entryName=cylinderT,
name=cylinderT,
region=fluid,
patch=fluid_to_solid,
field=T
)
#includeFunc patchAverage
(
entryName=inletU,
name=inletU,
region=fluid,
patch=inlet,
field=U

View File

@ -61,7 +61,7 @@ functions
{
#includeFunc patchAverage
(
entryName=cylinderToil,
name=cylinderToil,
region=fluid,
patch=fluid_to_solid,
field=T.oil
@ -69,7 +69,7 @@ functions
#includeFunc patchAverage
(
entryName=cylinderTwater,
name=cylinderTwater,
region=fluid,
patch=fluid_to_solid,
field=T.water

View File

@ -20,7 +20,7 @@ runApplication reconstructPar -latestTime -allRegions
runApplication foamPostProcess -latestTime -region fluid -func "
graphCell
(
entryName=graph,
name=graph,
start=(3.4901 0 0),
end=(3.4901 0.0096 0),
fields=(alpha.gas T.liquid T.gas)
@ -28,7 +28,7 @@ runApplication foamPostProcess -latestTime -region fluid -func "
runApplication -append foamPostProcess -region fluid -latestTime -func "
patchSurface
(
entryName=patchWallBoilingProperties,
name=patchWallBoilingProperties,
patch=wall,
surfaceFormat=raw,
interpolate=false,

View File

@ -60,9 +60,9 @@ maxDeltaT 0.005;
functions
{
#includeFunc wallHeatFlux(entryName=WHFliquid, writeFields=false, phase=liquid, region=fluid)
#includeFunc wallHeatFlux(entryName=WHFgas, writeFields=false, phase=gas, region=fluid)
#includeFunc wallHeatFlux(entryName=WHFsolid, writeFields=false, region=solid, log=yes)
#includeFunc wallHeatFlux(name=WHFliquid, writeFields=false, phase=liquid, region=fluid)
#includeFunc wallHeatFlux(name=WHFgas, writeFields=false, phase=gas, region=fluid)
#includeFunc wallHeatFlux(name=WHFsolid, writeFields=false, region=solid, log=yes)
writeWallBoilingProperties
{

View File

@ -49,7 +49,7 @@ runTimeModifiable true;
functions
{
#includeFunc residuals(p_rgh)
#includeFunc streamlinesLine(entryName=streamlines, start=(0 0.5 0), end=(9 0.5 0), nPoints=24, U)
#includeFunc streamlinesLine(name=streamlines, start=(0 0.5 0), end=(9 0.5 0), nPoints=24, U)
}
// ************************************************************************* //

View File

@ -52,7 +52,7 @@ functions
#includeFunc graphUniform
(
entryName=wallShearStressGraph,
name=wallShearStressGraph,
start=(0.04075 0.00075 0),
end=(3.04 0.00075 0),
nPoints=100,
@ -62,7 +62,7 @@ functions
#includeFunc graphUniform
(
entryName=kGraph,
name=kGraph,
start=(0.04075 0.05 0),
end=(3.04 0.05 0),
nPoints=100,

View File

@ -82,9 +82,9 @@ functions
}
#includeFunc patchFlowRate(patch=outlet1)
#includeFunc faceZoneFlowRate(name=fz1)
#includeFunc faceZoneFlowRate(faceZone=fz1)
#includeFunc patchFlowRate(patch=outlet2)
#includeFunc faceZoneFlowRate(name=fz2)
#includeFunc faceZoneFlowRate(faceZone=fz2)
}
// ************************************************************************* //

View File

@ -52,9 +52,9 @@ maxCo 0.5;
functions
{
#includeFunc patchFlowRate(entryName=inletFlowRate, patch=inlet)
#includeFunc patchFlowRate(entryName=lowerOutletFlowRate, patch=lowerOutlet)
#includeFunc patchFlowRate(entryName=upperOutletFlowRate, patch=upperOutlet)
#includeFunc patchFlowRate(name=inletFlowRate, patch=inlet)
#includeFunc patchFlowRate(name=lowerOutletFlowRate, patch=lowerOutlet)
#includeFunc patchFlowRate(name=upperOutletFlowRate, patch=upperOutlet)
#includeFunc scalarTransport(s)
#includeFunc reconstruct(phi)
#includeFunc streamlinesPatch(patch=inlet, nPoints=100, U=reconstruct(phi))

View File

@ -53,7 +53,7 @@ functions
#includeFunc uniform
(
fieldType = volScalarField,
name = half,
field = half,
dimensions = [0 0 0 0 0 0 0],
value = 0.5
)
@ -64,7 +64,7 @@ functions
#includeFunc graphLayerAverage
(
entryName = layerAverage,
name = layerAverage,
patches = (bottomWall),
axis = y,
symmetric = yes,

View File

@ -57,7 +57,7 @@ functions
#includeFunc streamlinesSphere
(
entryName=streamlines,
name=streamlines,
centre=(4 0 0.7),
radius=1,
nPoints=30,
@ -66,7 +66,7 @@ functions
#includeFunc cutPlaneSurface
(
entryName=xNormal,
name=xNormal,
point=(4 0 1),
normal=(1 0 0),
fields=(p U)
@ -74,13 +74,13 @@ functions
#includeFunc cutPlaneSurface
(
entryName=yNormal,
name=yNormal,
point=(-5 0.02 1),
normal=(0 1 0),
fields=(p U)
)
#includeFunc patchSurface(entryName=car, patch=".*(body|Wheels)", p)
#includeFunc patchSurface(name=car, patch=".*(body|Wheels)", p)
}
// ************************************************************************* //

View File

@ -53,7 +53,7 @@ functions
clouds
{
type fvModel;
#includeModel clouds(entryName=fvModel)
#includeModel clouds(name=fvModel)
}
}

View File

@ -53,7 +53,7 @@ functions
clouds
{
type fvModel;
#includeModel clouds(entryName=fvModel)
#includeModel clouds(name=fvModel)
}
}

View File

@ -52,8 +52,8 @@ maxCo 1.0;
functions
{
#includeFunc patchFlowRate(patch=inlet, entryName=inletFlowRate)
#includeFunc patchFlowRate(patch=outlet, entryName=outletFlowRate)
#includeFunc patchFlowRate(name=inletFlowRate, patch=inlet)
#includeFunc patchFlowRate(name=outletFlowRate, patch=outlet)
cartesianToCylindrical
{

View File

@ -53,7 +53,7 @@ functions
clouds
{
type fvModel;
#includeModel clouds(entryName=fvModel)
#includeModel clouds(name=fvModel)
}
}

View File

@ -52,8 +52,8 @@ maxCo 0.5;
functions
{
#includeFunc patchFlowRate(patch=inlet, entryName=inletFlowRate)
#includeFunc patchFlowRate(patch=outlet, entryName=outletFlowRate)
#includeFunc patchFlowRate(name=inletFlowRate, patch=inlet)
#includeFunc patchFlowRate(name=outletFlowRate, patch=outlet)
}

View File

@ -55,7 +55,7 @@ functions
{
#includeFunc streamlinesLine
(
entryName=streamlines,
name=streamlines,
start=(-0.0205 0.001 0.00001),
end=(-0.0205 0.0251 0.00001),
nPoints=10,

View File

@ -47,9 +47,9 @@ runTimeModifiable true;
functions
{
#includeFunc graphCell(entryName=lineA, start=(-0.0016 0 0), end=(-0.0016 0.0128 0), U)
#includeFunc graphCell(entryName=lineB, start=(-0.0048 0 0), end=(-0.0048 0.0128 0), U)
#includeFunc graphCell(entryName=lineC, start=(-0.0032 0 0), end=(-0.0032 0.0128 0), U)
#includeFunc graphCell(name=lineA, start=(-0.0016 0 0), end=(-0.0016 0.0128 0), U)
#includeFunc graphCell(name=lineB, start=(-0.0048 0 0), end=(-0.0048 0.0128 0), U)
#includeFunc graphCell(name=lineC, start=(-0.0032 0 0), end=(-0.0032 0.0128 0), U)
}
// ************************************************************************* //

View File

@ -48,8 +48,8 @@ runTimeModifiable true;
functions
{
#includeFunc residuals(p, sigma)
#includeFunc graphCell(entryName=graph, start=(0 0 0), end=(0 1 0), U)
#includeFunc probes(entryName=probes, points=((0 1 0)), U)
#includeFunc graphCell(name=graph, start=(0 0 0), end=(0 1 0), U)
#includeFunc probes(name=probes, points=((0 1 0)), U)
}
// ************************************************************************* //

View File

@ -11,7 +11,7 @@ runApplication -s age foamPostProcess -solver $(getSolver) -latestTime \
runApplication -s probes1 foamPostProcess -func probes1 -latestTime
runApplication -s probes2 foamPostProcess -func probes2 -latestTime
runApplication -s patchFlowRate foamPostProcess -latestTime \
-func "patchFlowRate(entryName=inletFlowRate,patch=inlet)" -latestTime
-func "patchFlowRate(name=inletFlowRate,patch=inlet)" -latestTime
(cd validation && ./Allrun $*)

View File

@ -56,7 +56,7 @@ DebugSwitches
functions
{
#includeFunc adjustTimeStepToChemistry
#includeFunc probes(funcName=probe, points=((0 0 0)), T, p)
#includeFunc probes(name=probe, points=((0 0 0)), T, p)
}
// ************************************************************************* //

View File

@ -56,7 +56,7 @@ functions
{
#includeFunc graphCell
(
entryName=graph,
name=graph,
start=(0.0101 0 0),
end=(0.0101 0.01905 0),
fields=(alpha.gas)

View File

@ -60,7 +60,7 @@ functions
#includeFunc phaseForces(phase=water)
#includeFunc graphUniform
(
entryName=graph,
name=graph,
start=(0 0 0.89),
end=(0.025 0 0.89),
nPoints=100,
@ -77,24 +77,24 @@ functions
#includeFunc populationBalanceSizeDistribution
(
name=probabilityDensity.injection,
populationBalance=bubbles,
regionType=cellZone,
name=injection,
cellZone=injection,
functionType=volumeDensity,
coordinateType=diameter,
normalise=yes,
entryName=probabilityDensity.injection
normalise=yes
)
#includeFunc populationBalanceSizeDistribution
(
name=probabilityDensity.outlet,
populationBalance=bubbles,
regionType=cellZone,
name=outlet,
cellZone=outlet,
functionType=volumeDensity,
coordinateType=diameter,
normalise=yes,
entryName=probabilityDensity.outlet
normalise=yes
)
}

View File

@ -57,7 +57,7 @@ functions
#includeFunc cellMin
(
entryName=min,
name=min,
alpha.liquid,
alpha.gas,
p,
@ -70,7 +70,7 @@ functions
#includeFunc cellMax
(
entryName=max,
name=max,
alpha.liquid,
alpha.gas,
p,
@ -83,7 +83,7 @@ functions
#includeFunc graphPatchCutLayerAverage
(
entryName=hydrofoilLowerPressure,
name=hydrofoilLowerPressure,
patch=hydrofoilLower,
direction=(0.15 -0.016 0),
nPoints=100,
@ -92,7 +92,7 @@ functions
#includeFunc graphPatchCutLayerAverage
(
entryName=hydrofoilUpperPressure,
name=hydrofoilUpperPressure,
patch=hydrofoilUpper,
direction=(0.15 -0.016 0),
nPoints=100,

View File

@ -17,7 +17,7 @@ runApplication reconstructPar -latestTime
runApplication foamPostProcess -func "
graphLayerAverage
(
entryName=graphCrossSection,
name=graphCrossSection,
patches=(inlet),
axis=distance,
d.particles

View File

@ -57,46 +57,46 @@ functions
#includeFunc populationBalanceSizeDistribution
(
name=probabilityDensity.afterBend_1d,
populationBalance=agglomerates,
regionType=cellZone,
name=afterBend_1d,
cellZone=afterBend_1d,
functionType=volumeDensity,
coordinateType=diameter,
normalise=yes,
entryName=probabilityDensity.afterBend_1d
normalise=yes
)
#includeFunc populationBalanceSizeDistribution
(
name=probabilityDensity.afterBend_5d,
populationBalance=agglomerates,
regionType=cellZone,
name=afterBend_5d,
cellZone=afterBend_5d,
functionType=volumeDensity,
coordinateType=diameter,
normalise=yes,
entryName=probabilityDensity.afterBend_5d
normalise=yes
)
#includeFunc populationBalanceSizeDistribution
(
name=probabilityDensity.afterBend_9d,
populationBalance=agglomerates,
regionType=cellZone,
name=afterBend_9d,
cellZone=afterBend_9d,
functionType=volumeDensity,
coordinateType=diameter,
normalise=yes,
entryName=probabilityDensity.afterBend_9d
normalise=yes
)
#includeFunc populationBalanceSizeDistribution
(
name=probabilityDensity.beforeBend_1d,
populationBalance=agglomerates,
regionType=cellZone,
name=beforeBend_1d,
cellZone=beforeBend_1d,
functionType=volumeDensity,
coordinateType=diameter,
normalise=yes,
entryName=probabilityDensity.beforeBend_1d
normalise=yes
)
}

View File

@ -56,7 +56,7 @@ functions
{
#includeFunc graphCell
(
entryName=graph,
name=graph,
start=(0 0 1e-3),
end=(0.44 0 1e-3),
fields=(TiCl4.vapour O2.vapour Cl2.vapour alpha.particles)
@ -64,15 +64,15 @@ functions
#includeFunc populationBalanceSizeDistribution
(
name=numberDensity,
populationBalance=aggregates,
regionType=cellZone,
name=outlet,
cellZone=outlet,
functionType=numberDensity,
coordinateType=projectedAreaDiameter,
allCoordinates=yes,
normalise=yes,
logTransform=yes,
entryName=numberDensity
logTransform=yes
)
#includeFunc writeObjects

View File

@ -56,7 +56,7 @@ functions
{
#includeFunc graphCell
(
entryName=graph,
name=graph,
start=(0 0 1e-3),
end=(0.44 0 1e-3),
fields=(TiCl4.vapour O2.vapour Cl2.vapour alpha.particles)
@ -64,15 +64,15 @@ functions
#includeFunc populationBalanceSizeDistribution
(
name=numberDensity,
populationBalance=aggregates,
regionType=cellZone,
name=outlet,
cellZone=outlet,
functionType=numberDensity,
coordinateType=projectedAreaDiameter,
allCoordinates=yes,
normalise=yes,
logTransform=yes,
entryName=numberDensity
logTransform=yes
)
#includeFunc writeObjects

View File

@ -15,7 +15,7 @@ runApplication reconstructPar -latestTime
runApplication foamPostProcess -latestTime -func "
graphCell
(
entryName=graph,
name=graph,
start=(3.4901 0 0),
end=(3.4901 0.0096 0),
fields=(alpha.gas T.liquid T.gas d.gas)
@ -23,7 +23,7 @@ runApplication foamPostProcess -latestTime -func "
runApplication -append foamPostProcess -latestTime -func "
patchSurface
(
entryName=patchWallBoilingProperties,
name=patchWallBoilingProperties,
patch=wall,
surfaceFormat=raw,
interpolate=false,

View File

@ -16,7 +16,7 @@ runApplication reconstructPar -latestTime
runApplication foamPostProcess -latestTime -func "
graphCell
(
entryName=graph,
name=graph,
start=(3.4901 0 0),
end=(3.4901 0.0096 0),
fields=(alpha.gas T.liquid T.gas d.gas)
@ -24,7 +24,7 @@ runApplication foamPostProcess -latestTime -func "
runApplication -append foamPostProcess -latestTime -func "
patchSurface
(
entryName=patchWallBoilingProperties,
name=patchWallBoilingProperties,
patch=wall,
surfaceFormat=raw,
interpolate=false,

View File

@ -16,7 +16,7 @@ runApplication reconstructPar -latestTime
runApplication foamPostProcess -latestTime -func "
graphCell
(
entryName=graph,
name=graph,
start=(3.4901 0 0),
end=(3.4901 0.0096 0),
fields=(alpha.gas alpha.gas2 alpha.liquid T.liquid T.gas d.bubbles)
@ -24,7 +24,7 @@ runApplication foamPostProcess -latestTime -func "
runApplication -append foamPostProcess -latestTime -func "
patchSurface
(
entryName=patchWallBoilingProperties,
name=patchWallBoilingProperties,
patch=wall,
surfaceFormat=raw,
interpolate=false,