TimeIntegrator.h

Go to the documentation of this file.

/*------------------------------------------------------------------------*/
/*  Copyright 2014 Sandia Corporation.                                    */
/*  This software is released under the license detailed                  */
/*  in the file, LICENSE, which is located in the top-level Nalu          */
/*  directory structure                                                   */
/*------------------------------------------------------------------------*/


#ifndef TimeIntegrator_h
#define TimeIntegrator_h

#include <Enums.h>
// yaml for parsing..
#include <yaml-cpp/yaml.h>

#include <vector>
#include <string>


namespace sierra{
namespace nalu{

class Realm;
class Simulation;

class TimeIntegrator
{
public:

  TimeIntegrator() {}
  TimeIntegrator(Simulation* sim);
  ~TimeIntegrator();

  void load(const YAML::Node & node) ;

  void breadboard();

  void initialize();
  Simulation *root();
  Simulation *parent();

  void integrate_realm();
  void provide_mean_norm();
  bool simulation_proceeds();
  Simulation* sim_{nullptr};

  double totalSimTime_;
  double currentTime_;
  double timeStepFromFile_;
  double timeStepN_;
  double timeStepNm1_;
  double gamma1_;
  double gamma2_;
  double gamma3_;
  int timeStepCount_;
  int maxTimeStepCount_;
  bool secondOrderTimeAccurate_;
  bool adaptiveTimeStep_;
  bool terminateBasedOnTime_;
  int nonlinearIterations_;

  std::string name_;

  std::vector<std::string> realmNamesVec_;

  std::vector<Realm*> realmVec_;

  double get_time_step(
  const NaluState &theState = NALU_STATE_N) const;
  double get_current_time() const;
  double get_gamma1() const;
  double get_gamma2() const;
  double get_gamma3() const;
  int get_time_step_count() const;
  double get_time_step_from_file();
  bool get_is_fixed_time_step();
  bool get_is_terminate_based_on_time();
  double get_total_sim_time();
  int get_max_time_step_count();
  void compute_gamma();
 
};

} // namespace nalu
} // namespace Sierra

#endif