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 a84ffc3968
commit 3eec5854be
181 changed files with 232 additions and 440 deletions

View File

@ -23,7 +23,6 @@ boundaryField
inlet
{
type totalPressure;
U U;
rho rho;
psi none;
gamma 1;

View File

@ -23,7 +23,6 @@ boundaryField
inlet
{
type totalPressure;
U U;
rho rho;
psi none;
gamma 1;

View File

@ -23,7 +23,6 @@ boundaryField
inlet
{
type totalPressure;
U U;
rho rho;
psi none;
gamma 1;

View File

@ -42,8 +42,6 @@ boundaryField
{
type totalPressure;
p0 uniform 1e5;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -39,8 +39,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -59,8 +59,6 @@ functions
libs ( "libforces.so" );
patches (hull);
rhoInf 998.8;
rhoName rho;
UName U;
log on;
writeControl timeStep;
writeInterval 1;

View File

@ -38,8 +38,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -28,8 +28,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -35,7 +35,6 @@ boundaryField
outlet
{
type pressureInletOutletVelocity;
phi phi;
value $internalField;
}

View File

@ -42,8 +42,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -39,8 +39,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -39,8 +39,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -53,8 +53,6 @@ functions
libs ( "libforces.so" );
patches (hull);
rhoInf 998.8;
rhoName rho;
UName U;
log on;
writeControl timeStep;
writeInterval 1;

View File

@ -42,8 +42,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -24,8 +24,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

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

View File

@ -41,8 +41,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho none;
psi none;
gamma 1;

View File

@ -42,8 +42,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

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

View File

@ -30,7 +30,6 @@ boundaryField
outlet
{
type pressureInletOutletVelocity;
phi phi;
value $internalField;
}

View File

@ -42,8 +42,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -42,8 +42,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -42,8 +42,6 @@ boundaryField
{
type totalPressure;
p0 uniform 0;
U U;
phi phi;
rho rho;
psi none;
gamma 1;

View File

@ -59,9 +59,7 @@ functions
libs ("libforces.so");
writeControl writeTime;
patches (floatingObject);
pName p;
UName U;
rhoName rhoInf;
rho rhoInf;
log yes;
rhoInf 1000;
CofR (0 0 0);

View File

@ -57,11 +57,9 @@ functions
{
type forces;
libs ("libforces.so");
writeControl writeTime;
writeControl writeTime;
patches (floatingObject);
pName p;
UName U;
rhoName rhoInf;
rho rhoInf;
log yes;
rhoInf 1000;
CofR (0 0 0);

View File

@ -1903,7 +1903,7 @@ boundaryField
inlet
{
type mapped;
fieldName epsilon.liquid;
field epsilon.liquid;
setAverage 0;
average 0;
interpolationScheme cell;

View File

@ -1903,7 +1903,7 @@ boundaryField
inlet
{
type mapped;
fieldName k.liquid;
field k.liquid;
setAverage 0;
average 0;
interpolationScheme cell;