STYLE: renamed meshSubsetHelper -> fvMeshSubsetProxy

applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C

@@ -90,7 +90,7 @@ Note
 #include "ensightOutput.H"
 
 // local files
-#include "meshSubsetHelper.H"
+#include "fvMeshSubsetProxy.H"
 #include "ensightOutputCloud.H"
 
 #include "memInfo.H"
@@ -256,11 +256,12 @@ int main(int argc, char *argv[])
     if (args.readIfPresent("cellZone", cellZoneName))
     {
         Info<< "Converting cellZone " << cellZoneName
-            << " only (puts outside faces into patch "
-            << mesh.boundaryMesh()[0].name() << ")"
-            << endl;
+            << " only. Places new outside faces into \"oldInternalFaces\"."
+            << nl;
     }
-    meshSubsetHelper meshRef(mesh, meshSubsetHelper::ZONE, cellZoneName);
+
+    // fvMeshSubset is ignored if cellZoneName is empty
+    fvMeshSubsetProxy meshRef(mesh, fvMeshSubsetProxy::ZONE, cellZoneName);
 
     //
     // Open new ensight case file, initialize header etc.

applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C

@@ -108,7 +108,7 @@ Usage
         use the time index in the VTK file name instead of the time index
 
 Note
-    mesh subset is handled by meshSubsetHelper. Slight inconsistency in
+    The mesh subset is handled by fvMeshSubsetProxy. Slight inconsistency in
     interpolation: on the internal field it interpolates the whole volField
     to the whole-mesh pointField and then selects only those values it
     needs for the subMesh (using the fvMeshSubset cellMap(), pointMap()
@@ -158,7 +158,7 @@ Note
 #include "passiveParticle.H"
 #include "wordRes.H"
 #include "areaFields.H"
-#include "meshSubsetHelper.H"
+#include "fvMeshSubsetProxy.H"
 #include "readFields.H"
 #include "faceSet.H"
 #include "pointSet.H"
@@ -482,17 +482,17 @@ int main(int argc, char *argv[])
 
     string vtkName = runTime.caseName();
 
-    meshSubsetHelper::subsetType cellSubsetType = meshSubsetHelper::NONE;
+    fvMeshSubsetProxy::subsetType cellSubsetType = fvMeshSubsetProxy::NONE;
     word cellSubsetName;
     if (args.readIfPresent("cellSet", cellSubsetName))
     {
         vtkName = cellSubsetName;
-        cellSubsetType = meshSubsetHelper::SET;
+        cellSubsetType = fvMeshSubsetProxy::SET;
     }
     else if (args.readIfPresent("cellZone", cellSubsetName))
     {
         vtkName = cellSubsetName;
-        cellSubsetType = meshSubsetHelper::ZONE;
+        cellSubsetType = fvMeshSubsetProxy::ZONE;
     }
     else if (Pstream::parRun())
     {
@@ -554,7 +554,7 @@ int main(int argc, char *argv[])
     instantList timeDirs = timeSelector::select0(runTime, args);
 
     // Mesh wrapper: does subsetting and decomposition
-    meshSubsetHelper meshRef(mesh, cellSubsetType, cellSubsetName);
+    fvMeshSubsetProxy meshRef(mesh, cellSubsetType, cellSubsetName);
 
     // Collect decomposition information etc.
     vtk::vtuCells vtuMeshCells(fmtType, decomposePoly);

applications/utilities/postProcessing/dataConversion/foamToVTK/readFields.C

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2016-2018 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -36,7 +36,7 @@ namespace Foam
 template<class GeoField>
 label readFields
 (
-    const meshSubsetHelper& helper,
+    const fvMeshSubsetProxy& proxy,
     const typename GeoField::Mesh& mesh,
     const IOobjectList& objects,
     const wordHashSet& selectedFields,
@@ -58,7 +58,7 @@ label readFields
             fields.set
             (
                 nFields++,
-                helper.interpolate
+                proxy.interpolate
                 (
                     GeoField(*(objects[fieldName]), mesh)
                 ).ptr()

applications/utilities/postProcessing/dataConversion/foamToVTK/readFields.H

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2016-2018 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -34,7 +34,7 @@ SourceFiles
 #ifndef readFields_H
 #define readFields_H
 
-#include "meshSubsetHelper.H"
+#include "fvMeshSubsetProxy.H"
 #include "PtrList.H"
 #include "IOobjectList.H"
 #include "HashSet.H"
@@ -48,7 +48,7 @@ namespace Foam
 template<class GeoField>
 label readFields
 (
-    const meshSubsetHelper& helper,
+    const fvMeshSubsetProxy& proxy,
     const typename GeoField::Mesh& mesh,
     const IOobjectList& objects,
     const wordHashSet& selectedFields,

src/dynamicMesh/Make/files

@@ -90,7 +90,7 @@ polyMeshAdder/polyMeshAdder.C
 fvMeshTools/fvMeshTools.C
 
 fvMeshSubset/fvMeshSubset.C
-meshSubsetHelper/meshSubsetHelper.C
+fvMeshSubsetProxy/fvMeshSubsetProxy.C
 
 motionSmoother/motionSmoother.C
 motionSmoother/motionSmootherAlgo.C

src/dynamicMesh/meshSubsetHelper/meshSubsetHelper.C → src/dynamicMesh/fvMeshSubsetProxy/fvMeshSubsetProxy.C

@@ -23,14 +23,14 @@ License
 
 \*---------------------------------------------------------------------------*/
 
-#include "meshSubsetHelper.H"
+#include "fvMeshSubsetProxy.H"
 #include "cellSet.H"
 #include "cellZone.H"
 #include "Time.H"
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
-Foam::meshSubsetHelper::meshSubsetHelper
+Foam::fvMeshSubsetProxy::fvMeshSubsetProxy
 (
     fvMesh& baseMesh
 )
@@ -45,7 +45,7 @@ Foam::meshSubsetHelper::meshSubsetHelper
 }
 
 
-Foam::meshSubsetHelper::meshSubsetHelper
+Foam::fvMeshSubsetProxy::fvMeshSubsetProxy
 (
     fvMesh& baseMesh,
     const subsetType type,
@@ -65,7 +65,7 @@ Foam::meshSubsetHelper::meshSubsetHelper
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
-void Foam::meshSubsetHelper::correct(bool verbose)
+void Foam::fvMeshSubsetProxy::correct(bool verbose)
 {
     if (type_ == SET)
     {
@@ -96,7 +96,7 @@ void Foam::meshSubsetHelper::correct(bool verbose)
 }
 
 
-Foam::polyMesh::readUpdateState Foam::meshSubsetHelper::readUpdate()
+Foam::polyMesh::readUpdateState Foam::fvMeshSubsetProxy::readUpdate()
 {
     const polyMesh::readUpdateState meshState = baseMesh_.readUpdate();
 

src/dynamicMesh/meshSubsetHelper/meshSubsetHelper.H → src/dynamicMesh/fvMeshSubsetProxy/fvMeshSubsetProxy.H

@@ -22,19 +22,20 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::meshSubsetHelper
+    Foam::fvMeshSubsetProxy
 
 Description
-    Simple helper to hold a mesh or mesh-subset and provide uniform access.
+    Simple proxy for holding a mesh, or mesh-subset.
+    The subMeshes are currently limited to cellSet or cellZone definitions.
 
 SourceFiles
-    meshSubsetHelper.C
-    meshSubsetHelperTemplates.C
+    fvMeshSubsetProxy.C
+    fvMeshSubsetProxyTemplates.C
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef meshSubsetHelper_H
-#define meshSubsetHelper_H
+#ifndef fvMeshSubsetProxy_H
+#define fvMeshSubsetProxy_H
 
 #include "fvMeshSubset.H"
 #include "zeroGradientFvPatchField.H"
@@ -48,10 +49,10 @@ namespace Foam
 class Time;
 
 /*---------------------------------------------------------------------------*\
-                      Class meshSubsetHelper Declaration
+                      Class fvMeshSubsetProxy Declaration
 \*---------------------------------------------------------------------------*/
 
-class meshSubsetHelper
+class fvMeshSubsetProxy
 {
 public:
 
@@ -87,10 +88,10 @@ private:
     // Private Member Functions
 
         //- No copy construct
-        meshSubsetHelper(const meshSubsetHelper&) = delete;
+        fvMeshSubsetProxy(const fvMeshSubsetProxy&) = delete;
 
         //- No copy assignment
-        void operator=(const meshSubsetHelper&) = delete;
+        void operator=(const fvMeshSubsetProxy&) = delete;
 
 
 public:
@@ -98,10 +99,10 @@ public:
     // Constructors
 
         //- Construct from components
-        meshSubsetHelper(fvMesh& baseMesh);
+        fvMeshSubsetProxy(fvMesh& baseMesh);
 
         //- Construct from components
-        meshSubsetHelper
+        fvMeshSubsetProxy
         (
             fvMesh& baseMesh,
             const subsetType,
@@ -211,10 +212,9 @@ public:
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 #ifdef NoRepository
-    #include "meshSubsetHelperTemplates.C"
+    #include "fvMeshSubsetProxyTemplates.C"
 #endif
 
-
 #endif
 
 // ************************************************************************* //

src/dynamicMesh/meshSubsetHelper/meshSubsetHelperTemplates.C → src/dynamicMesh/fvMeshSubsetProxy/fvMeshSubsetProxyTemplates.C

@@ -23,14 +23,14 @@ License
 
 \*---------------------------------------------------------------------------*/
 
-#include "meshSubsetHelper.H"
+#include "fvMeshSubsetProxy.H"
 #include "volFields.H"
 
 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
 
 template<class Type>
 Foam::tmp<Foam::GeometricField<Type, Foam::fvPatchField, Foam::volMesh>>
-Foam::meshSubsetHelper::zeroGradientField
+Foam::fvMeshSubsetProxy::zeroGradientField
 (
     const typename GeometricField
     <
@@ -62,7 +62,7 @@ Foam::meshSubsetHelper::zeroGradientField
 
 template<class Type>
 Foam::tmp<Foam::GeometricField<Type, Foam::fvPatchField, Foam::volMesh>>
-Foam::meshSubsetHelper::interpolate
+Foam::fvMeshSubsetProxy::interpolate
 (
     const GeometricField<Type, fvPatchField, volMesh>& vf
 ) const
@@ -82,7 +82,7 @@ Foam::meshSubsetHelper::interpolate
 
 template<class Type>
 Foam::tmp<Foam::GeometricField<Type, Foam::fvPatchField, Foam::volMesh>>
-Foam::meshSubsetHelper::interpolate
+Foam::fvMeshSubsetProxy::interpolate
 (
     const typename GeometricField
     <
@@ -105,7 +105,7 @@ Foam::meshSubsetHelper::interpolate
 
 template<class GeoField>
 Foam::tmp<GeoField>
-Foam::meshSubsetHelper::interpolate
+Foam::fvMeshSubsetProxy::interpolate
 (
     const GeoField& fld
 ) const

src/dynamicMesh/fvMeshSubsetProxy/meshSubsetHelper.H

+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2018 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM, licensed under GNU General Public License
+    <http://www.gnu.org/licenses/>.
+
+Typedef
+    Foam::meshSubsetHelper
+
+Description
+    Compatibility name. Rename (JUL-2018) as Foam::fvMeshSubsetProxy
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef meshSubsetHelper_H
+#define meshSubsetHelper_H
+
+#include "fvMeshSubsetProxy.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+     typedef fvMeshSubsetProxy meshSubsetHelper;
+}
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //