added more parsers and towards finishing advection

* refer #56.
* added parsers to read general and time sections from inputs file.
* WIP: advection algorithm.

Signed-off-by: Lakshman Anumolu <acrlakshman@yahoo.co.in>

Author: acrlakshman

applications/advection/main.cc

@@ -44,12 +44,16 @@ int main(int argc, char **argv)
 
   std::string inputs_file;
   if (argc == 1) {
-    std::cout << "./<executable> <inputs_file>" << std::endl;
+    std::cout << "<path-to-executable>/<executable> <path-to-inputs_file>" << std::endl;
     exit(0);
   } else {
     inputs_file = std::string(argv[1]);
 
-    // TODO (lakshman): Check if the file exists.
+    GALS::UTILITIES::FileUtils file_utils;
+    if (!file_utils.fileExists(inputs_file)) {
+      std::cout << "File: " << inputs_file << " does not exist" << std::endl;
+      exit(0);
+    }
   }
 
   const int dim = 2;
@@ -62,6 +66,11 @@ int main(int argc, char **argv)
 
   input_parser.parse(inputs_file, &input_fields);
 
+  GALS::UTILITIES::FileUtils file_utils;
+
+  const auto &general_inputs = *(input_fields.m_general);
+  file_utils.setRootDirectory(general_inputs.output_directory + "/");
+
   // Construct grid.
   const auto &grid_inputs = *(input_fields.m_grid);
   T_GRID grid(grid_inputs.nx, grid_inputs.ny, grid_inputs.nz);
@@ -96,9 +105,29 @@ int main(int argc, char **argv)
   GALS::ANALYTICAL_FIELDS::Velocity<T_GRID, T> velocity(grid, velocity_inputs);
   velocity.compute(positions, velocity_field);
 
+  const auto &time_inputs = *(input_fields.m_time);
+
+  T t_start = time_inputs.start;
+  T t_end = time_inputs.end;
+  T dt = time_inputs.dt;
+  bool is_dt_fixed = std::strcmp(time_inputs.constant_dt.c_str(), "NO");
+  T sim_time = 0;
+
+  if (!is_dt_fixed) {
+    dt = grid.dX().min() / 2.;
+  }
+
+  // Time loop
+  bool run_sim = true;
+  while (run_sim) {
+    sim_time += dt;
+
+    //
+
+    if (GALS::is_equal(sim_time, t_end) || sim_time > t_end) run_sim = false;
+  }
+
   // Write velocity to a file.
-  GALS::UTILITIES::FileUtils file_utils;
-  file_utils.setRootDirectory("tmp/advection/");
   file_utils.createDirectory(file_utils.getRootDirectory());
   file_utils.write(std::string(file_utils.getRootDirectory() + "velocity"), velocity_field);
 

include/gals/input-fields/general.h

@@ -0,0 +1,45 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright 2019 Lakshman Anumolu, Raunak Bardia.
+//
+// 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.
+///////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include <string>
+
+namespace GALS
+{
+namespace INPUT_FIELDS
+{
+struct General {
+  std::string output_directory;
+};
+
+}  // namespace INPUT_FIELDS
+}  // namespace GALS

include/gals/input-fields/input-fields.h

@@ -31,7 +31,9 @@
 
 #pragma once
 
+#include "general.h"
 #include "grid.h"
+#include "time.h"
 #include "velocity.h"
 
 namespace GALS
@@ -53,7 +55,9 @@ class InputFields
    */
   ~InputFields();
 
+  GALS::INPUT_FIELDS::General *m_general;
   GALS::INPUT_FIELDS::Grid *m_grid;
+  GALS::INPUT_FIELDS::Time *m_time;
   GALS::INPUT_FIELDS::Velocity *m_velocity;
 };
 

include/gals/input-fields/time.h

@@ -0,0 +1,46 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright 2019 Lakshman Anumolu, Raunak Bardia.
+//
+// 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.
+///////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include <string>
+
+namespace GALS
+{
+namespace INPUT_FIELDS
+{
+struct Time {
+  double start, end, dt;
+  std::string constant_dt;
+};
+
+}  // namespace INPUT_FIELDS
+}  // namespace GALS

include/gals/input-fields/velocity.h

@@ -42,6 +42,7 @@ struct Velocity {
   std::string name;            //! Name of velocity field.
   std::vector<double> vector;  //! Uniform velocity magnitudes of all components.
   std::vector<double> center;  //! Center of velocity field for few velocity types.
+  std::string gradient_scheme;  //! Scheme to compute gradient of velocity field.
 };
 
 }  // namespace INPUT_FIELDS

include/gals/input-parser/general.h

@@ -0,0 +1,73 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright 2019 Lakshman Anumolu, Raunak Bardia.
+//
+// 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.
+///////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include "gals/input-fields/input-fields.h"
+
+#include "yaml-cpp/yaml.h"
+
+namespace GALS
+{
+namespace INPUT_PARSER
+{
+/*! \class General
+ *
+ * Class to parse input fields for grid.
+ */
+class General
+{
+ public:
+  /*! Default constructor
+   */
+  General();
+
+  /*! Destructor
+   */
+  ~General();
+
+  /*! Parse input variables for grid section.
+   *
+   * \param field YAML node for grid.
+   * \param p_input_fields pointer to input fields object.
+   */
+  void parse(const YAML::Node &field, GALS::INPUT_FIELDS::InputFields *p_input_fields);
+
+  /*! Overloaded operator to parse.
+   *
+   * \param field YAML node for grid.
+   * \param p_input_fields pointer to input fields object.
+   */
+  void operator()(const YAML::Node &field, GALS::INPUT_FIELDS::InputFields *p_input_fields);
+};
+
+}  // namespace INPUT_PARSER
+}  // namespace GALS

include/gals/input-parser/grid.h

@@ -69,5 +69,5 @@ class Grid
   void operator()(const YAML::Node &field, GALS::INPUT_FIELDS::InputFields *p_input_fields);
 };
 
-}  // namespace CPU
+}  // namespace INPUT_PARSER
 }  // namespace GALS

include/gals/input-parser/time.h

@@ -0,0 +1,73 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright 2019 Lakshman Anumolu, Raunak Bardia.
+//
+// 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.
+///////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include "gals/input-fields/input-fields.h"
+
+#include "yaml-cpp/yaml.h"
+
+namespace GALS
+{
+namespace INPUT_PARSER
+{
+/*! \class Time
+ *
+ * Class to parse input fields for grid.
+ */
+class Time
+{
+ public:
+  /*! Default constructor
+   */
+  Time();
+
+  /*! Destructor
+   */
+  ~Time();
+
+  /*! Parse input variables for grid section.
+   *
+   * \param field YAML node for grid.
+   * \param p_input_fields pointer to input fields object.
+   */
+  void parse(const YAML::Node &field, GALS::INPUT_FIELDS::InputFields *p_input_fields);
+
+  /*! Overloaded operator to parse.
+   *
+   * \param field YAML node for grid.
+   * \param p_input_fields pointer to input fields object.
+   */
+  void operator()(const YAML::Node &field, GALS::INPUT_FIELDS::InputFields *p_input_fields);
+};
+
+}  // namespace INPUT_PARSER
+}  // namespace GALS

include/gals/utilities/file-utils.h

@@ -67,6 +67,14 @@ class FileUtils
    */
   const std::string getRootDirectory() const;
 
+  /*! Checks if file exists or not.
+   *
+   * \param file_name name of file with relative or absolute path.
+   *
+   * \return true if exists, false otherwise.
+   */
+  bool fileExists(const std::string file_name) const;
+
   /*! Remove file.
    *
    * \param file_name name of file with relative or absolute path.

include/gals/utilities/vec3.h

@@ -72,6 +72,12 @@ class Vec3
    */
   const int size() const;
 
+  /*! Returns minimum value from the array.
+   *
+   * \return minimum value.
+   */
+  const T min() const;
+
   /*! Overloaded subscript operator that returns a const value.
    *
    * \param idx zero based index of element.