ENH: simplify method names for reading argList options and arguments

- use succincter method names that more closely resemble dictionary
  and HashTable method names. This improves method name consistency
  between classes and also requires less typing effort:

    args.found(optName)        vs.  args.optionFound(optName)
    args.readIfPresent(..)     vs.  args.optionReadIfPresent(..)
    ...
    args.opt<scalar>(optName)  vs.  args.optionRead<scalar>(optName)
    args.read<scalar>(index)   vs.  args.argRead<scalar>(index)

- the older method names forms have been retained for code compatibility,
  but are now deprecated
This commit is contained in:
Mark Olesen
2018-01-08 15:35:18 +01:00
parent 2feb11dbeb
commit 345a2a42f1
168 changed files with 1161 additions and 1040 deletions

View File

@ -28,7 +28,7 @@ surfaceScalarField phi
fvc::flux(U)
);
if (args.optionFound("initialiseUBCs"))
if (args.found("initialiseUBCs"))
{
U.correctBoundaryConditions();
phi = fvc::flux(U);
@ -41,7 +41,7 @@ if (args.optionFound("initialiseUBCs"))
word pName("p");
// Update name of the pressure field from the command-line option
args.optionReadIfPresent("pName", pName);
args.readIfPresent("pName", pName);
// Infer the pressure BCs from the velocity
wordList pBCTypes

View File

@ -28,7 +28,7 @@ surfaceScalarField phi
fvc::flux(U)
);
if (args.optionFound("initialiseUBCs"))
if (args.found("initialiseUBCs"))
{
U.correctBoundaryConditions();
phi = fvc::flux(U);
@ -41,7 +41,7 @@ if (args.optionFound("initialiseUBCs"))
word pName("p");
// Update name of the pressure field from the command-line option
args.optionReadIfPresent("pName", pName);
args.readIfPresent("pName", pName);
// Infer the pressure BCs from the velocity
wordList pBCTypes

View File

@ -193,13 +193,13 @@ int main(int argc, char *argv[])
phi.write();
// Optionally write Phi
if (args.optionFound("writePhi"))
if (args.found("writePhi"))
{
Phi.write();
}
// Calculate the pressure field from the Euler equation
if (args.optionFound("writep"))
if (args.found("writep"))
{
Info<< nl << "Calculating approximate pressure field" << endl;

View File

@ -181,13 +181,13 @@ int main(int argc, char *argv[])
phi.write();
// Optionally write Phi
if (args.optionFound("writePhi"))
if (args.found("writePhi"))
{
Phi.write();
}
// Calculate the pressure field from the Euler equation
if (args.optionFound("writep"))
if (args.found("writep"))
{
Info<< nl << "Calculating approximate pressure field" << endl;

View File

@ -86,7 +86,7 @@ int main(int argc, char *argv[])
psi.write();
if (!args.optionFound("noH") || args.optionFound("HdotGradH"))
if (!args.found("noH") || args.found("HdotGradH"))
{
volVectorField H
(
@ -99,7 +99,7 @@ int main(int argc, char *argv[])
fvc::reconstruct(fvc::snGrad(psi)*mesh.magSf())
);
if (!args.optionFound("noH"))
if (!args.found("noH"))
{
Info<< nl
<< "Creating field H for time "
@ -108,7 +108,7 @@ int main(int argc, char *argv[])
H.write();
}
if (args.optionFound("HdotGradH"))
if (args.found("HdotGradH"))
{
Info<< nl
<< "Creating field HdotGradH for time "
@ -129,7 +129,7 @@ int main(int argc, char *argv[])
}
}
if (!args.optionFound("noB"))
if (!args.found("noB"))
{
Info<< nl
<< "Creating field B for time "

View File

@ -123,7 +123,7 @@ volScalarField alphac
);
word kinematicCloudName("kinematicCloud");
args.optionReadIfPresent("cloud", kinematicCloudName);
args.readIfPresent("cloud", kinematicCloudName);
Info<< "Constructing kinematicCloud " << kinematicCloudName << endl;
basicKinematicTypeCloud kinematicCloud

View File

@ -58,7 +58,7 @@ volScalarField mu
);
word kinematicCloudName("kinematicCloud");
args.optionReadIfPresent("cloud", kinematicCloudName);
args.readIfPresent("cloud", kinematicCloudName);
Info<< "Constructing kinematicCloud " << kinematicCloudName << endl;
basicKinematicCollidingCloud kinematicCloud

View File

@ -51,7 +51,7 @@ autoPtr<compressible::turbulenceModel> turbulence
const word kinematicCloudName
(
args.optionLookupOrDefault<word>("cloud", "kinematicCloud")
args.lookupOrDefault<word>("cloud", "kinematicCloud")
);
Info<< "Constructing kinematicCloud " << kinematicCloudName << endl;