feat(core): Create a base class for the instances which provides a unique identifier

Author: sanguinariojoe

source/Body.cpp

@@ -39,7 +39,7 @@ using namespace std;
 namespace moordyn {
 
 Body::Body(moordyn::Log* log, size_t id)
-  : io::IO(log)
+  : Instance(log)
   , bodyId(id)
 {
 #ifdef USE_VTK

source/Body.hpp

@@ -40,7 +40,7 @@
 #pragma once
 
 #include "Misc.hpp"
-#include "IO.hpp"
+#include "Instance.hpp"
 #include "Util/CFL.hpp"
 #include <vector>
 #include <utility>
@@ -69,11 +69,8 @@ class Rod;
  * In the configuration file the options are:
  *
  * Name/ID, X0, Y0, Z0, Xcg, Ycg, Zcg, M, V, IX, IY, IZ, CdA-x,y,z Ca-x,y,z
- *
- * moordyn::Body extends the io::IO class, allowing it to perform input/output
- * in a consistent manner.
  */
-class DECLDIR Body final : public io::IO, public SuperCFL
+class DECLDIR Body final : public Instance, public SuperCFL
 {
   public:
 	/** @brief Costructor

source/CMakeLists.txt

@@ -1,6 +1,7 @@
 set(MOORDYN_SRCS
     Body.cpp
     Point.cpp
+    Instance.cpp
     IO.cpp
     Line.cpp
     Log.cpp
@@ -23,6 +24,7 @@ set(MOORDYN_SRCS
 set(MOORDYN_HEADERS
     Body.hpp
     Point.hpp
+    Instance.hpp
     IO.hpp
     Line.hpp
     Log.hpp

source/Instance.cpp

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2019 Matt Hall <[email protected]>
+ *
+ * This file is part of MoorDyn.  MoorDyn is free software: you can redistribute
+ * it and/or modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation, either version 3 of the License,
+ * or (at your option) any later version.
+ *
+ * MoorDyn is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with MoorDyn.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "Instance.hpp"
+#include <atomic>
+
+namespace moordyn {
+
+std::atomic<size_t> __instances_counter(0);
+
+Instance::Instance(moordyn::Log* log)
+  : io::IO(log)
+{
+	_id = __instances_counter++;
+}
+
+}  // ::moordyn

source/Instance.hpp

@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) 2022, Matt Hall
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/** @file Instance.hpp
+ * Base class for the moordyn::Body, moordyn::Line, moordyn::Point and
+ * moordyn::Rod objects.
+ */
+
+#pragma once
+
+#include "IO.hpp"
+#include "Log.hpp"
+#include <utility>
+
+namespace moordyn {
+
+class Waves;
+typedef std::shared_ptr<Waves> WavesRef;
+
+class Point;
+class Rod;
+
+/** @class Instance Instance.hpp
+ * @brief A generic instance
+ */
+class DECLDIR Instance : public io::IO
+{
+  public:
+	/** @brief Costructor
+	 * @param log Logging handler defining where/how results should be logged.
+	 */
+	Instance(moordyn::Log* log);
+
+	/** @brief Destructor
+	 */
+	virtual ~Instance() = default;
+
+	/** @brief Get the unique identifier of this instance
+	 *
+	 * The unique identifier is a growing index which identifies every single
+	 * created instance. Even if an instance is removed, the index will remain
+	 * taken.
+	 * @return The unique identifier
+	 */
+	inline const size_t Id() const { return _id; }
+
+	/** @brief Get the number of state variables required by this instance
+	 *
+	 * This can be seen as the number of rows on the state variables holder.
+	 * @return The number of state variables
+	 */
+	virtual inline const size_t state_n() const { return 1; }
+
+	/** @brief Get the dimension of the state variable.
+	 *
+	 * This can be seen as the number of columns on the state variables holder.
+	 * @return The dimension of the state variable
+	 */
+	virtual inline const size_t state_dims() const { return 6; }
+  private:
+	/// Unique identifier of this instance
+	size_t _id;
+};
+
+} // ::moordyn

source/Line.cpp

@@ -51,7 +51,7 @@ namespace moordyn {
 using namespace waves;
 
 Line::Line(moordyn::Log* log, size_t lineId)
-  : io::IO(log)
+  : Instance(log)
   , lineId(lineId)
   , isPb(false)
 {

source/Line.hpp

@@ -35,7 +35,7 @@
 #pragma once
 
 #include "Misc.hpp"
-#include "IO.hpp"
+#include "Instance.hpp"
 #include "Seafloor.hpp"
 #include "Util/CFL.hpp"
 #include <utility>
@@ -70,7 +70,7 @@ typedef Eigen::Ref<Eigen::Matrix<list, Eigen::Dynamic, 1>> StateVarRef;
  * The integration time step (moordyn::MoorDyn.dtM0) should be smaller than
  * this natural period to avoid numerical instabilities
  */
-class DECLDIR Line final : public io::IO, public NatFreqCFL
+class DECLDIR Line final : public Instance, public NatFreqCFL
 {
   public:
 	/** @brief Constructor

source/Point.cpp

@@ -46,7 +46,7 @@
 namespace moordyn {
 
 Point::Point(moordyn::Log* log, size_t id)
-  : io::IO(log)
+  : Instance(log)
   , seafloor(nullptr)
   , pointId(id)
 {

source/Point.hpp

@@ -35,7 +35,7 @@
 #pragma once
 
 #include "Misc.hpp"
-#include "IO.hpp"
+#include "Instance.hpp"
 #include "Seafloor.hpp"
 #include "Util/CFL.hpp"
 #include <utility>
@@ -67,7 +67,7 @@ typedef std::shared_ptr<Waves> WavesRef;
  *          weight or float via the point's mass and volume parameters
  *  - Coupled: The point position and velocity is externally imposed
  */
-class DECLDIR Point final : public io::IO, public SuperCFL
+class DECLDIR Point final : public Instance, public SuperCFL
 {
   public:
 	/** @brief Constructor

source/Rod.cpp

@@ -54,7 +54,7 @@ namespace moordyn {
 //   ... --- seg n-2 --- [node n-1] --- seg n-1 ---  [point (node N)]
 
 Rod::Rod(moordyn::Log* log, size_t rodId)
-  : io::IO(log)
+  : Instance(log)
   , seafloor(nullptr)
   , rodId(rodId)
 {