Standardized the selection of required and optional fields in BCs, fvOptions, functionObjects etc.

In most boundary conditions, fvOptions etc. required and optional fields
to be looked-up from the objectRegistry are selected by setting the
keyword corresponding to the standard field name in the BC etc. to the
appropriate name in the objectRegistry.  Usually a default is provided
with sets the field name to the keyword name, e.g. in the
totalPressureFvPatchScalarField the velocity is selected by setting the
keyword 'U' to the appropriate name which defaults to 'U':

        Property     | Description             | Required    | Default value
        U            | velocity field name     | no          | U
        phi          | flux field name         | no          | phi
        .
        .
        .

However, in some BCs and functionObjects and many fvOptions another
convention is used in which the field name keyword is appended by 'Name'
e.g.

        Property     | Description             | Required    | Default value
        pName        | pressure field name     | no          | p
        UName        | velocity field name     | no          | U

This difference in convention is unnecessary and confusing, hinders code
and dictionary reuse and complicates code maintenance.  In this commit
the appended 'Name' is removed from the field selection keywords
standardizing OpenFOAM on the first convention above.
This commit is contained in:
Henry Weller
2016-05-21 20:28:20 +01:00
parent ddfbaa7fa4
commit e22c65dd8e
181 changed files with 232 additions and 440 deletions

View File

@ -44,7 +44,6 @@ boundaryField
openingTime 0.01;
maxOpenFractionDelta 0.1;
openFraction 0;
p p;
minThresholdValue 8000;
forceBased 0;
}

View File

@ -56,7 +56,6 @@ dictionaryReplacement
openingTime 0.01;
maxOpenFractionDelta 0.1;
openFraction 0;
p p;
minThresholdValue 8000;
forceBased 0;
value uniform (0 0 0);

View File

@ -45,16 +45,12 @@ boundaryField
inlet
{
type totalFlowRateAdvectiveDiffusive;
phi phi;
rho rho;
value uniform 1;
}
region0_to_pyrolysisRegion_coupledWall
{
type totalFlowRateAdvectiveDiffusive;
phi phi;
rho rho;
massFluxFraction 1.0;
value $internalField;
}

View File

@ -24,7 +24,6 @@ boundaryField
region0_to_pyrolysisRegion_coupledWall
{
type greyDiffusiveRadiation;
T T;
emissivityMode solidRadiation;
emissivity uniform 1.0;
value uniform 0;
@ -38,7 +37,6 @@ boundaryField
".*"
{
type greyDiffusiveRadiation;
T T;
emissivityMode lookup;
emissivity uniform 1.0;
value uniform 0;

View File

@ -50,8 +50,6 @@ boundaryField
region0_to_pyrolysisRegion_coupledWall
{
type totalFlowRateAdvectiveDiffusive;
phi phi;
rho rho;
massFluxFraction 0.0;
value $internalField;
}

View File

@ -52,10 +52,9 @@ boundaryField
pyrolysisRegion pyrolysisRegion;
filmRegion filmRegion;
Tnbr T;
kappa fluidThermo;
kappaMethod fluidThermo;
QrNbr none;
Qr Qr;
kappaName none;
filmDeltaDry 0.0;
filmDeltaWet 2e-4;
value $internalField;

View File

@ -38,7 +38,6 @@ boundaryField
side
{
type pressureInletOutletVelocity;
phi phi;
value $internalField;
}
@ -52,9 +51,7 @@ boundaryField
region0_to_pyrolysisRegion_coupledWall
{
type mappedFlowRate;
phi phi;
nbrPhi phiGas;
rho rho;
value uniform (0 0 0);
}
}

View File

@ -44,16 +44,12 @@ boundaryField
inlet
{
type fixedValue;
phi phi;
rho rho;
value uniform 0;
}
region0_to_pyrolysisRegion_coupledWall
{
type totalFlowRateAdvectiveDiffusive;
phi phi;
rho rho;
massFluxFraction 0.0;
value $internalField;
}

View File

@ -29,7 +29,7 @@ boundaryField
sampleMode nearestPatchFace;
samplePatch region0_to_pyrolysisRegion_coupledWall;
offset (0 0 0);
fieldName T;
field T;
setAverage no;
average 0;
value uniform 298;

View File

@ -38,7 +38,7 @@ boundaryField
sampleMode nearestPatchFace;
samplePatch region0_to_pyrolysisRegion_coupledWall;
offset (0 0 0);
fieldName Qr; // this is the name of Qr field in region0
field Qr; // this is the name of Qr field in region0
setAverage no;
average 0;
value uniform 0;

View File

@ -37,8 +37,7 @@ boundaryField
pyrolysisRegion pyrolysisRegion;
filmRegion filmRegion;
Tnbr T;
kappa solidThermo;
kappaName none;
kappaMethod solidThermo;
QrNbr Qr;
Qr none;
filmDeltaDry 0.0;

View File

@ -40,15 +40,11 @@ boundaryField
burner
{
type totalFlowRateAdvectiveDiffusive;
phi phi;
rho rho;
value uniform 1.0;
}
"(region0_to.*)"
{
type totalFlowRateAdvectiveDiffusive;
phi phi;
rho rho;
value $internalField;
}
}

View File

@ -23,7 +23,6 @@ boundaryField
".*"
{
type MarshakRadiation;
T T;
emissivityMode lookup;
emissivity uniform 1.0;
value uniform 0;
@ -32,7 +31,6 @@ boundaryField
"(region0_to.*)"
{
type MarshakRadiation;
T T;
emissivityMode solidRadiation;
value uniform 0;
}

View File

@ -23,7 +23,6 @@ boundaryField
".*"
{
type greyDiffusiveRadiation;
T T;
emissivityMode lookup;
emissivity uniform 1.0;
value uniform 0;
@ -31,7 +30,6 @@ boundaryField
"(region0_to.*)"
{
type greyDiffusiveRadiation;
T T;
emissivityMode solidRadiation;
value uniform 0;
}

View File

@ -50,10 +50,9 @@ boundaryField
{
type compressible::turbulentTemperatureRadCoupledMixed;
Tnbr T;
kappa fluidThermo;
kappaMethod fluidThermo;
QrNbr none;
Qr Qr;
kappaName none;
value $internalField;
}
}

View File

@ -37,16 +37,13 @@ boundaryField
"(top|sides)"
{
type pressureInletOutletVelocity;
phi phi;
value $internalField;
}
"(region0_to.*)"
{
type mappedFlowRate;
phi phi;
nbrPhi phiGas;
rho rho;
value uniform (0 0 0);
}
}

View File

@ -43,7 +43,7 @@ boundaryField
sampleMode nearestPatchFace;
samplePatch region0_to_panelRegion_fLeft_zone;
offset (0 0 0);
fieldName Qr;
field Qr;
setAverage no;
average 0;
value uniform 0;
@ -56,7 +56,7 @@ boundaryField
sampleMode nearestPatchFace;
samplePatch region0_to_panelRegion_fRight_zone;
offset (0 0 0);
fieldName Qr;
field Qr;
setAverage no;
average 0;
value uniform 0;

View File

@ -41,8 +41,7 @@ boundaryField
{
type compressible::turbulentTemperatureRadCoupledMixed;
Tnbr T;
kappa solidThermo;
kappaName none;
kappaMethod solidThermo;
QrNbr Qr;
Qr none;
value uniform 298.15;

View File

@ -23,7 +23,6 @@ boundaryField
".*"
{
type MarshakRadiation;
T T;
emissivityMode lookup;
emissivity uniform 1.0;
value uniform 0;

View File

@ -23,7 +23,6 @@ boundaryField
".*"
{
type greyDiffusiveRadiation;
T T;
emissivityMode lookup;
emissivity uniform 1.0;
value uniform 0;

View File

@ -23,7 +23,6 @@ boundaryField
".*"
{
type MarshakRadiation;
T T;
emissivityMode lookup;
emissivity uniform 1.0;
value uniform 0;

View File

@ -23,7 +23,6 @@ boundaryField
".*"
{
type greyDiffusiveRadiation;
T T;
emissivityMode lookup;
emissivity uniform 1;
value uniform 0;

View File

@ -25,7 +25,6 @@ boundaryField
{
type pressureInletOutletVelocity;
value uniform (0 0 0);
phi phi;
}
base

View File

@ -33,8 +33,6 @@ boundaryField
{
type totalPressure;
p0 $internalField;
U U;
phi phi;
rho none;
psi none;
gamma 1;

View File

@ -33,8 +33,6 @@ boundaryField
{
type totalPressure;
p0 $internalField;
U U;
phi phi;
rho none;
psi none;
gamma 1;