2018-06-23 13:05 BST

View Issue Details Jump to Notes ]
IDProjectCategoryView StatusLast Update
0002951OpenFOAMPatchpublic2018-05-22 22:35
Reporterwyldckat 
Assigned Tohenry 
PrioritylowSeveritytextReproducibilityN/A
StatusresolvedResolutionfixed 
Product Versiondev 
Target VersionFixed in Version5.x 
Summary0002951: Several descriptions in headers still mention 'fileName' instead of 'file'
DescriptionThis patch provides two fixes:

  - The main fix is for all of the occurrences I could find with:

       grep -r -e " fileName " -e " fileName *|" src applications

  - A small fix for 'partialSlipFvPatchField.H', where 'od' was used in the description instead of 'of'.


Attached are the following files:

  - bug2951_dev.patch - for seeing the changes made for OpenFOAM-dev

  - bug2951_dev.tar.gz - with all of the modified files for OpenFOAM-dev:

    applications/utilities/postProcessing/noise/noise.C
    src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
    src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H
    src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H
    src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
    src/engine/engineTime/freePiston/freePiston.H
    src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H
    src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
    src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
    src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H
    src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H
    src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
Additional InformationThis is related to 2950, simply because the 'fixedProfile' boundary type example was also indicating 'fileName' instead of 'file'.
TagsNo tags attached.
Attached Files
  • gz file icon bug2951_dev.tar.gz (11,813 bytes) 2018-05-22 18:37
  • patch file icon bug2951_dev.patch (14,131 bytes) 2018-05-22 18:37 -
    diff --git a/applications/utilities/postProcessing/noise/noise.C b/applications/utilities/postProcessing/noise/noise.C
    index c27da7f..435d7f4 100644
    --- a/applications/utilities/postProcessing/noise/noise.C
    +++ b/applications/utilities/postProcessing/noise/noise.C
    @@ -43,7 +43,7 @@ Usage
     
         pressureData
         {
    -        fileName        "pressureData"
    +        file                "pressureData";
             nHeaderLine         1;          // number of header lines
             refColumn           0;          // reference column index
             componentColumns    (1);        // component column indices
    diff --git a/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H b/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
    index 6ba1295..53c49d8 100644
    --- a/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
    +++ b/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
    @@ -2,7 +2,7 @@
       =========                 |
       \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
        \\    /   O peration     |
    -    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
    +    \\  /    A nd           | Copyright (C) 2011-2018 OpenFOAM Foundation
          \\/     M anipulation  |
     -------------------------------------------------------------------------------
     License
    @@ -42,7 +42,7 @@ Description
         Read csv format:
         \verbatim
             readerType      csv;
    -        fileName        "$FOAM_CASE/constant/p0vsTime.csv";
    +        file            "$FOAM_CASE/constant/p0vsTime.csv";
             hasHeaderLine   true;   // skip first line
             timeColumn      0;      // time is in column 0
             valueColumns    (1);    // value starts in column 1
    diff --git a/src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H b/src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H
    index 638ef5a..1f60d24 100644
    --- a/src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H
    +++ b/src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H
    @@ -39,7 +39,7 @@ Description
                 componentColumns    (1 2 3);    // component column indices
                 separator           ",";        // optional (defaults to ",")
                 mergeSeparators     no;         // merge multiple separators
    -            fileName            "fileXYZ";  // name of csv data file
    +            file                "fileXYZ";  // name of csv data file
                 outOfBounds         clamp;      // optional out-of-bounds handling
                 interpolationScheme linear;     // optional interpolation scheme
             }
    diff --git a/src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H b/src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H
    index 8d570b1..6a19493 100644
    --- a/src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H
    +++ b/src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H
    @@ -2,7 +2,7 @@
       =========                 |
       \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
        \\    /   O peration     |
    -    \\  /    A nd           | Copyright (C) 2011-2017 OpenFOAM Foundation
    +    \\  /    A nd           | Copyright (C) 2011-2018 OpenFOAM Foundation
          \\/     M anipulation  |
     -------------------------------------------------------------------------------
     License
    @@ -32,7 +32,7 @@ Description
             <entryName> tableFile;
             <entryName>Coeffs
             {
    -            fileName            dataFile;    // name of data file
    +            file                dataFile;    // name of data file
                 outOfBounds         clamp;       // optional out-of-bounds handling
                 interpolationScheme linear;      // optional interpolation method
             }
    diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
    index 42e3efa..72f8ab6 100644
    --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
    +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
    @@ -2,7 +2,7 @@
       =========                 |
       \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
        \\    /   O peration     |
    -    \\  /    A nd           | Copyright (C) 2013-2017 OpenFOAM Foundation
    +    \\  /    A nd           | Copyright (C) 2013-2018 OpenFOAM Foundation
          \\/     M anipulation  |
     -------------------------------------------------------------------------------
     License
    @@ -87,7 +87,7 @@ Usage
         \table
             Property     | Description             | Required    | Default value
             commsDir     | communications directory   | yes         |
    -        fileName     | transfer file name      | yes         |
    +        file         | transfer file name      | yes         |
             waitInterval | interval [s] between file checks | no | 1
             timeOut      | time after which error invoked [s] |no |100*waitInterval
             calcFrequency | calculation frequency  | no          | 1
    @@ -100,7 +100,7 @@ Usage
             {
                 type            externalCoupledTemperature;
                 commsDir        "$FOAM_CASE/comms";
    -            fileName        data;
    +            file            data;
                 calcFrequency   1;
             }
         \endverbatim
    diff --git a/src/engine/engineTime/freePiston/freePiston.H b/src/engine/engineTime/freePiston/freePiston.H
    index 47fff43..33dc04c 100644
    --- a/src/engine/engineTime/freePiston/freePiston.H
    +++ b/src/engine/engineTime/freePiston/freePiston.H
    @@ -2,7 +2,7 @@
       =========                 |
       \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
        \\    /   O peration     |
    -    \\  /    A nd           | Copyright (C) 2017 OpenFOAM Foundation
    +    \\  /    A nd           | Copyright (C) 2017-2018 OpenFOAM Foundation
          \\/     M anipulation  |
     -------------------------------------------------------------------------------
     License
    @@ -42,7 +42,7 @@ Description
             pistonPositionTime  tableFile;
             pistonPositionTimeCoeffs
             {
    -            fileName            "data";
    +            file                "data";
                 outOfBounds         clamp;
                 interpolationScheme linear;
             }
    diff --git a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H
    index 690e74d..5846478 100644
    --- a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H
    +++ b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H
    @@ -2,7 +2,7 @@
       =========                 |
       \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
        \\    /   O peration     |
    -    \\  /    A nd           | Copyright (C) 2013-2017 OpenFOAM Foundation
    +    \\  /    A nd           | Copyright (C) 2013-2018 OpenFOAM Foundation
          \\/     M anipulation  |
     -------------------------------------------------------------------------------
     License
    @@ -87,7 +87,7 @@ Usage
         \table
             Property     | Description             | Required    | Default value
             commsDir     | communications directory   | yes         |
    -        fileName     | transfer file name      | yes         |
    +        file         | transfer file name      | yes         |
             waitInterval | interval [s] between file checks | no | 1
             timeOut      | time after which error invoked [s] |no |100*waitInterval
             calcFrequency | calculation frequency  | no          | 1
    @@ -101,7 +101,7 @@ Usage
         {
             type            externalCoupled;
             commsDir        "$FOAM_CASE/comms";
    -        fileName        data;
    +        file            data;
             calcFrequency   1;
             initByExternal  yes;
         }
    diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
    index 84928f9..65a0cd9 100644
    --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
    +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
    @@ -56,7 +56,7 @@ Usage
                 refColumn       0;
                 componentColumns 1(1);
                 separator       ",";
    -            fileName        "$FOAM_CASE/constant/pressureVsU";
    +            file           "$FOAM_CASE/constant/pressureVsU";
             }
             value           uniform 0;
         }
    diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
    index aa4b19f..1d00c56 100644
    --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
    +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
    @@ -2,7 +2,7 @@
       =========                 |
       \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
        \\    /   O peration     |
    -    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
    +    \\  /    A nd           | Copyright (C) 2011-2018 OpenFOAM Foundation
          \\/     M anipulation  |
     -------------------------------------------------------------------------------
     License
    @@ -34,7 +34,7 @@ Description
     Usage
         \table
             Property     | Description             | Required    | Default value
    -        fileName     | fan curve file name     | yes         |
    +        file         | fan curve file name     | yes         |
             outOfBounds  | out of bounds handling  | yes         |
             direction    | direction of flow through fan [in/out] | yes |
             p0           | environmental total pressure | yes    |
    @@ -45,7 +45,7 @@ Usage
         inlet
         {
             type            fanPressure;
    -        fileName        "fanCurve";
    +        file            "fanCurve";
             outOfBounds     clamp;
             direction       in;
             p0              uniform 0;
    @@ -55,7 +55,7 @@ Usage
         outlet
         {
             type            fanPressure;
    -        fileName        "fanCurve";
    +        file            "fanCurve";
             outOfBounds     clamp;
             direction       out;
             p0              uniform 0;
    diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H
    index 502be93..c955eaf 100644
    --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H
    +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H
    @@ -2,7 +2,7 @@
       =========                 |
       \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
        \\    /   O peration     |
    -    \\  /    A nd           | Copyright (C) 2015-2016 OpenFOAM Foundation
    +    \\  /    A nd           | Copyright (C) 2015-2018 OpenFOAM Foundation
          \\/     M anipulation  |
     -------------------------------------------------------------------------------
     License
    @@ -43,7 +43,7 @@ Usage
         <patchName>
         {
             type            fixedProfile;
    -        profile    csvFile;
    +        profile         csvFile;
     
             profileCoeffs
             {
    @@ -52,7 +52,7 @@ Usage
                 componentColumns    (1 2 3);    // Component column indices
                 separator           ",";        // Optional (defaults to ",")
                 mergeSeparators     no;         // Merge multiple separators
    -            fileName            "Uprofile.csv";  // name of csv data file
    +            file                "Uprofile.csv";  // name of csv data file
                 outOfBounds         clamp;      // Optional out-of-bounds handling
                 interpolationScheme linear;     // Optional interpolation scheme
             }
    diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H
    index fb8d750..e137490 100644
    --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H
    +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H
    @@ -2,7 +2,7 @@
       =========                 |
       \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
        \\    /   O peration     |
    -    \\  /    A nd           | Copyright (C) 2011-2017 OpenFOAM Foundation
    +    \\  /    A nd           | Copyright (C) 2011-2018 OpenFOAM Foundation
          \\/     M anipulation  |
     -------------------------------------------------------------------------------
     License
    @@ -34,7 +34,7 @@ Description
     Usage
         \table
             Property      | Description             | Required    | Default value
    -        valueFraction | fraction od value used for boundary [0-1] | yes |
    +        valueFraction | fraction of value used for boundary [0-1] | yes |
         \endtable
     
         Example of the boundary condition specification:
    diff --git a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
    index 389a281..0e2c514 100644
    --- a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
    +++ b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
    @@ -75,7 +75,7 @@ Usage
             primaryInletT           293;
             faceZone                facesZoneInletOriented;
             outOfBounds             clamp;
    -        fileName                "effTable";
    +        file                    "effTable";
         }
         \endverbatim
     
    
    patch file icon bug2951_dev.patch (14,131 bytes) 2018-05-22 18:37 +
  • gz file icon bug2951_5x.tar.gz (11,249 bytes) 2018-05-22 19:26

-Relationships
+Relationships

-Notes

~0009623

wyldckat (updater)

Also attached 'bug2951_5x.tar.gz' for OpenFOAM 5.x, which has applied the same patch to OpenFOAM 5.x, with the exception "src/engine/engineTime/freePiston/freePiston.H" that doesn't exist in that version branch.

In other words, this tarball provides the following files from OpenFOAM 5.x, but patched for the same issues:

    applications/utilities/postProcessing/noise/noise.C
    src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
    src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H
    src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H
    src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
    src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H
    src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
    src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
    src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H
    src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H
    src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H

~0009625

henry (manager)

Resolved in OpenFOAM-5.x by commit a522b1ffdb75dc28e7e8091c508ab8e58d616bc7
Resolved in OpenFOAM-dev by commit 567fc9049250901def7c3fb5c3e37a0a02c1e721
+Notes

-Issue History
Date Modified Username Field Change
2018-05-22 18:37 wyldckat New Issue
2018-05-22 18:37 wyldckat Status new => assigned
2018-05-22 18:37 wyldckat Assigned To => henry
2018-05-22 18:37 wyldckat File Added: bug2951_dev.tar.gz
2018-05-22 18:37 wyldckat File Added: bug2951_dev.patch
2018-05-22 19:26 wyldckat File Added: bug2951_5x.tar.gz
2018-05-22 19:26 wyldckat Note Added: 0009623
2018-05-22 22:35 henry Status assigned => resolved
2018-05-22 22:35 henry Resolution open => fixed
2018-05-22 22:35 henry Fixed in Version => 5.x
2018-05-22 22:35 henry Note Added: 0009625
+Issue History