Beginning work on LinearMag class which will be a higher level interface to PDE code, tailored for the specific Mag problem in low suceptibility media.

include/FEM4EllipticPDE.h

@@ -93,6 +93,20 @@ namespace Lemma {
              */
             void Delete();
 
+
+            #ifdef HAVE_YAMLCPP
+            /**
+             *  Uses YAML to serialize this object.
+             *  @return a YAML::Node
+             */
+            YAML::Node Serialize() const;
+
+            /**
+             *   Constructs an object from a YAML::Node.
+             */
+            static FEM4EllipticPDE* DeSerialize(const YAML::Node& node);
+            #endif
+
             // ====================  OPERATORS     =======================
 
             // ====================  OPERATIONS    =======================
@@ -147,6 +161,11 @@ namespace Lemma {
             /// Default protected constructor.
             FEM4EllipticPDE (const std::string& cname);
 
+            #ifdef HAVE_YAMLCPP
+            /** Protected DeDerializing constructor, use factory DeSerialize  method*/
+            FEM4EllipticPDE (const YAML::Node& node);
+            #endif
+
             /** Default protected constructor. */
             ~FEM4EllipticPDE ();
 

include/LinearMag.h

@@ -0,0 +1,115 @@
+/* This file is part of Lemma, a geophysical modelling and inversion API.
+ * More information is available at http://lemmasoftware.org
+ */
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+/**
+ * @file
+ * @date      03/21/2016 01:39:32 PM
+ * @version   $Id$
+ * @author    Trevor Irons (ti)
+ * @email     tirons@egi.utah.edu
+ * @copyright Copyright (c) 2016, University of Utah
+ * @copyright Copyright (c) 2016, Lemma Software, LLC
+ */
+
+#ifndef  LINEARMAG_INC
+#define  LINEARMAG_INC
+
+#include	"FEM4EllipticPDE.h"
+
+namespace Lemma {
+
+    /** \addtogroup FEM4EllipticPDE
+     @{
+     */
+
+    /**
+      \brief   Provides modelling of linear magnetic media
+      \details This class solves the problem
+        \f{equation}{
+            \nabla^2 u(\mathbf{r}) = \nabla \cdot \kappa(\mathbf{r}) \mathbf{H}_0,
+        \f}
+        where \f$ \mathbf{H}_0\f$ is the static <B>homogeneous</B> inducing field, \f$ \kappa \f$
+        is the <B>isotropic</B> magnetic suceptibility. The secondary field can be calculated
+        \f$ \mathbf{H} = -\nabla \cdot u \f$
+     */
+    class LinearMag : public FEM4EllipticPDE {
+
+        friend std::ostream &operator<<(std::ostream &stream,
+                const LinearMag &ob);
+
+        public:
+
+        // ====================  LIFECYCLE     =======================
+
+        /**
+         * @copybrief LemmaObject::New()
+         * @copydetails LemmaObject::New()
+         */
+        static LinearMag* New();
+
+        /**
+         *  @copybrief   LemmaObject::Delete()
+         *  @copydetails LemmaObject::Delete()
+         */
+        void Delete();
+
+#ifdef HAVE_YAMLCPP
+        /**
+         *  Uses YAML to serialize this object.
+         *  @return a YAML::Node
+         */
+        YAML::Node Serialize() const;
+
+        /**
+         *   Constructs an object from a YAML::Node.
+         */
+        static LinearMag* DeSerialize(const YAML::Node& node);
+#endif
+
+        // ====================  OPERATORS     =======================
+
+        // ====================  OPERATIONS    =======================
+
+        // ====================  ACCESS        =======================
+
+        // ====================  INQUIRY       =======================
+
+        protected:
+
+        // ====================  LIFECYCLE     =======================
+
+        /** Default protected constructor, use New */
+        LinearMag (const std::string& name);
+
+#ifdef HAVE_YAMLCPP
+        /** Protected DeDerializing constructor, use factory DeSerialize  method*/
+        LinearMag (const YAML::Node& node);
+#endif
+
+        /** Default protected destructor, use Delete */
+        ~LinearMag ();
+
+        /**
+         *  @copybrief   LemmaObject::Release()
+         *  @copydetails LemmaObject::Release()
+         */
+        void Release();
+
+        private:
+
+        // ====================  DATA MEMBERS  =========================
+
+    }; // -----  end of class  LinearMag  -----
+
+    /*! @} */ // End of group
+
+}		// -----  end of Lemma  name  -----
+
+#endif   // ----- #ifndef LINEARMAG_INC  -----
+

src/CMakeLists.txt

@@ -1,5 +1,6 @@
 set (FEMSOURCE
 	${FEMSOURCE}
 	${CMAKE_CURRENT_SOURCE_DIR}/FEM4EllipticPDE.cpp
+	${CMAKE_CURRENT_SOURCE_DIR}/LinearMag.cpp
 	PARENT_SCOPE
 )

src/FEM4EllipticPDE.cpp

@@ -38,20 +38,39 @@
 
 namespace Lemma {
 
+#ifdef HAVE_YAMLCPP
+    std::ostream &operator << (std::ostream &stream, const FEM4EllipticPDE &ob) {
+        stream << ob.Serialize()  << "\n---\n"; // End of doc --- as a direct stream should encapulste thingy
+        return stream;
+    }
+#else
 	std::ostream &operator<<(std::ostream &stream,
 				const FEM4EllipticPDE &ob) {
-
 		stream << *(LemmaObject*)(&ob);
 		return stream;
 	}
+#endif
+
 
 	// ====================  LIFECYCLE     =======================
 
 	FEM4EllipticPDE::FEM4EllipticPDE(const std::string&name) :
 			LemmaObject(name), BndryH(10), BndrySigma(10),
-            vtkSigma(NULL), vtkG(NULL), vtkGrid(NULL), gFcn3(NULL) {
+            vtkSigma(nullptr), vtkG(nullptr), vtkGrid(nullptr), gFcn3(nullptr) {
 	}
 
+    #ifdef HAVE_YAMLCPP
+    //--------------------------------------------------------------------------------------
+    //       Class:  FEM4EllipticPDE
+    //      Method:  FEM4EllipticPDE
+    // Description:  DeSerializing constructor (protected)
+    //--------------------------------------------------------------------------------------
+    FEM4EllipticPDE::FEM4EllipticPDE (const YAML::Node& node) : LemmaObject(node) {
+        // TODO impliment
+        throw std::runtime_error("FEM4ELLIPTICPDE YAML CONSTRUCTOR NOT IMPLIMENTED!");
+    }  // -----  end of method FEM4EllipticPDE::FEM4EllipticPDE  (constructor)  -----
+    #endif
+
 	FEM4EllipticPDE::~FEM4EllipticPDE() {
 	}
 
@@ -69,6 +88,31 @@ namespace Lemma {
         this->DetachFrom(this);
     }
 
+#ifdef HAVE_YAMLCPP
+    //--------------------------------------------------------------------------------------
+    //       Class:  FEM4EllipticPDE
+    //      Method:  Serialize
+    //--------------------------------------------------------------------------------------
+    YAML::Node  FEM4EllipticPDE::Serialize (  ) const {
+        YAML::Node node = LemmaObject::Serialize();;
+        node.SetTag( this->Name );
+        // FILL IN CLASS SPECIFICS HERE
+        return node;
+    }		// -----  end of method FEM4EllipticPDE::Serialize  -----
+
+
+    //--------------------------------------------------------------------------------------
+    //       Class:  FEM4EllipticPDE
+    //      Method:  DeSerialize
+    //--------------------------------------------------------------------------------------
+    FEM4EllipticPDE* FEM4EllipticPDE::DeSerialize ( const YAML::Node& node  ) {
+        FEM4EllipticPDE* Object = new FEM4EllipticPDE(node);
+        Object->AttachTo(Object);
+        DESERIALIZECHECK( node, Object )
+            return Object ;
+    }		// -----  end of method FEM4EllipticPDE::DeSerialize  -----
+#endif
+
     // ====================  OPERATIONS    =======================
 
     void FEM4EllipticPDE::SetSigmaFunction(vtkImplicitFunction* sigma) {

src/LinearMag.cpp

@@ -0,0 +1,123 @@
+/* This file is part of Lemma, a geophysical modelling and inversion API.
+ * More information is available at http://lemmasoftware.org
+ */
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+/**
+ * @file
+ * @date      03/21/2016 02:10:08 PM
+ * @version   $Id$
+ * @author    Trevor Irons (ti)
+ * @email     tirons@egi.utah.edu
+ * @copyright Copyright (c) 2016, University of Utah
+ * @copyright Copyright (c) 2016, Lemma Software, LLC
+ */
+
+#include "LinearMag.h"
+
+namespace Lemma {
+
+// ====================  FRIEND METHODS  =====================
+#ifdef HAVE_YAMLCPP
+std::ostream &operator << (std::ostream &stream, const LinearMag &ob) {
+    stream << ob.Serialize()  << "\n---\n"; // End of doc --- as a direct stream should encapsulate thingy
+    return stream;
+}
+#else
+std::ostream &operator<<(std::ostream &stream, const LinearMag& ob) {
+    stream << *(FEM4EllipticPDE*)(&ob);
+    return stream;
+}
+#endif
+
+// ====================  LIFECYCLE     =======================
+
+//--------------------------------------------------------------------------------------
+//       Class:  LinearMag
+//      Method:  LinearMag
+// Description:  constructor (protected)
+//--------------------------------------------------------------------------------------
+LinearMag::LinearMag (const std::string& name) : FEM4EllipticPDE(name) {
+
+}  // -----  end of method LinearMag::LinearMag  (constructor)  -----
+
+#ifdef HAVE_YAMLCPP
+//--------------------------------------------------------------------------------------
+//       Class:  LinearMag
+//      Method:  LinearMag
+// Description:  DeSerializing constructor (protected)
+//--------------------------------------------------------------------------------------
+LinearMag::LinearMag (const YAML::Node& node) : FEM4EllipticPDE(node) {
+
+}  // -----  end of method LinearMag::LinearMag  (constructor)  -----
+#endif
+
+//--------------------------------------------------------------------------------------
+//       Class:  LinearMag
+//      Method:  New()
+// Description:  public constructor
+//--------------------------------------------------------------------------------------
+LinearMag* LinearMag::New() {
+    LinearMag*  Obj = new LinearMag("LinearMag");
+    Obj->AttachTo(Obj);
+    return Obj;
+}
+
+//--------------------------------------------------------------------------------------
+//       Class:  LinearMag
+//      Method:  ~LinearMag
+// Description:  destructor (protected)
+//--------------------------------------------------------------------------------------
+LinearMag::~LinearMag () {
+
+}  // -----  end of method LinearMag::~LinearMag  (destructor)  -----
+
+//--------------------------------------------------------------------------------------
+//       Class:  LinearMag
+//      Method:  Delete
+// Description:  public destructor
+//--------------------------------------------------------------------------------------
+void LinearMag::Delete() {
+    this->DetachFrom(this);
+}
+
+//--------------------------------------------------------------------------------------
+//       Class:  LinearMag
+//      Method:  Release
+// Description:  destructor (protected)
+//--------------------------------------------------------------------------------------
+void LinearMag::Release() {
+    delete this;
+}
+
+
+#ifdef HAVE_YAMLCPP
+//--------------------------------------------------------------------------------------
+//       Class:  LinearMag
+//      Method:  Serialize
+//--------------------------------------------------------------------------------------
+YAML::Node  LinearMag::Serialize (  ) const {
+    YAML::Node node = FEM4EllipticPDE::Serialize();;
+    node.SetTag( this->Name );
+    // FILL IN CLASS SPECIFICS HERE
+    return node;
+}		// -----  end of method LinearMag::Serialize  -----
+
+
+//--------------------------------------------------------------------------------------
+//       Class:  LinearMag
+//      Method:  DeSerialize
+//--------------------------------------------------------------------------------------
+LinearMag* LinearMag::DeSerialize ( const YAML::Node& node  ) {
+    LinearMag* Object = new LinearMag(node);
+    Object->AttachTo(Object);
+    DESERIALIZECHECK( node, Object )
+        return Object ;
+}		// -----  end of method LinearMag::DeSerialize  -----
+#endif
+
+}		// -----  end of Lemma  name  -----