functionObjects: Moved into the functionObjects namespace and rationalized and simplified failable construction

Rather than requiring each functionObject to handle failed construction
internally (using the active_ flag) the static member function "viable"
is provided which returns true if construction of the functionObject is
likely to be successful.  Failed construction is then handled by the
wrapper-class which constructs the functionObject,
e.g. "OutputFilterFunctionObject".

src/sampling/meshToMesh0/meshToMesh0Templates.C

@@ -303,7 +303,6 @@ void Foam::meshToMesh0::interpolate
                 }
                 case CELL_VOLUME_WEIGHT:
                 {
-                    // Do nothing
                     break;
                 }
 

src/sampling/probes/patchProbes.C

@@ -202,6 +202,18 @@ Foam::patchProbes::patchProbes
 }
 
 
+bool Foam::patchProbes::viable
+(
+    const word& name,
+    const objectRegistry& obr,
+    const dictionary& dict,
+    const bool loadFromFiles
+)
+{
+    return true;
+}
+
+
 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
 Foam::patchProbes::~patchProbes()

src/sampling/probes/patchProbes.H

@@ -138,6 +138,16 @@ public:
             const bool loadFromFiles = false
         );
 
+        //- Return true if the construction of this functionObject is viable
+        //  i.e. the prerequisites for construction are available
+        static bool viable
+        (
+            const word& name,
+            const objectRegistry&,
+            const dictionary&,
+            const bool loadFromFiles = false
+        );
+
 
     //- Destructor
     virtual ~patchProbes();

src/sampling/probes/probes.C

@@ -287,6 +287,18 @@ Foam::probes::probes
 }
 
 
+bool Foam::probes::viable
+(
+    const word& name,
+    const objectRegistry& obr,
+    const dictionary& dict,
+    const bool loadFromFiles
+)
+{
+    return true;
+}
+
+
 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
 Foam::probes::~probes()
@@ -296,21 +308,15 @@ Foam::probes::~probes()
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 void Foam::probes::execute()
-{
-    // Do nothing - only valid on write
-}
+{}
 
 
 void Foam::probes::end()
-{
-    // Do nothing - only valid on write
-}
+{}
 
 
 void Foam::probes::timeSet()
-{
-    // Do nothing - only valid on write
-}
+{}
 
 
 void Foam::probes::write()

src/sampling/probes/probes.H

@@ -210,6 +210,16 @@ public:
             const bool loadFromFiles = false
         );
 
+        //- Return true if the construction of this functionObject is viable
+        //  i.e. the prerequisites for construction are available
+        static bool viable
+        (
+            const word& name,
+            const objectRegistry&,
+            const dictionary&,
+            const bool loadFromFiles = false
+        );
+
 
     //- Destructor
     virtual ~probes();

src/sampling/sampledSet/sampledSets/sampledSets.C

@@ -162,6 +162,18 @@ Foam::sampledSets::sampledSets
 }
 
 
+bool Foam::sampledSets::viable
+(
+    const word& name,
+    const objectRegistry& obr,
+    const dictionary& dict,
+    const bool loadFromFiles
+)
+{
+    return true;
+}
+
+
 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
 Foam::sampledSets::~sampledSets()
@@ -177,21 +189,15 @@ void Foam::sampledSets::verbose(const bool verbosity)
 
 
 void Foam::sampledSets::execute()
-{
-    // Do nothing - only valid on write
-}
+{}
 
 
 void Foam::sampledSets::end()
-{
-    // Do nothing - only valid on write
-}
+{}
 
 
 void Foam::sampledSets::timeSet()
-{
-    // Do nothing - only valid on write
-}
+{}
 
 
 void Foam::sampledSets::write()

src/sampling/sampledSet/sampledSets/sampledSets.H

@@ -266,6 +266,16 @@ public:
             const bool loadFromFiles = false
         );
 
+        //- Return true if the construction of this functionObject is viable
+        //  i.e. the prerequisites for construction are available
+        static bool viable
+        (
+            const word& name,
+            const objectRegistry&,
+            const dictionary&,
+            const bool loadFromFiles = false
+        );
+
 
     //- Destructor
     virtual ~sampledSets();

src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011-2015 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -115,6 +115,19 @@ Foam::sampledSurfaces::sampledSurfaces
 }
 
 
+bool Foam::sampledSurfaces::viable
+(
+    const word& name,
+    const objectRegistry& obr,
+    const dictionary& dict,
+    const bool loadFromFiles
+)
+{
+    return true;
+}
+
+
+
 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
 Foam::sampledSurfaces::~sampledSurfaces()
@@ -130,21 +143,15 @@ void Foam::sampledSurfaces::verbose(const bool verbosity)
 
 
 void Foam::sampledSurfaces::execute()
-{
-    // Do nothing - only valid on write
-}
+{}
 
 
 void Foam::sampledSurfaces::end()
-{
-    // Do nothing - only valid on write
-}
+{}
 
 
 void Foam::sampledSurfaces::timeSet()
-{
-    // Do nothing - only valid on write
-}
+{}
 
 
 void Foam::sampledSurfaces::write()

src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.H

@@ -186,6 +186,16 @@ public:
             const bool loadFromFiles = false
         );
 
+        //- Return true if the construction of this functionObject is viable
+        //  i.e. the prerequisites for construction are available
+        static bool viable
+        (
+            const word& name,
+            const objectRegistry&,
+            const dictionary&,
+            const bool loadFromFiles = false
+        );
+
 
     //- Destructor
     virtual ~sampledSurfaces();