parameter_input.hpp

Go to the documentation of this file.

#ifndef PARAMETER_INPUT_HPP_
#define PARAMETER_INPUT_HPP_
//========================================================================================
// Athena++ astrophysical MHD code
// Copyright(C) 2014 James M. Stone <jmstone@princeton.edu> and other code contributors
// Licensed under the 3-clause BSD License, see LICENSE file for details
//========================================================================================
//  \brief definition of class ParameterInput
// Contains data structures used to store, and functions used to access, parameters
// read from the input file.  See comments at start of parameter_input.cpp for more
// information on the Athena++ input file format.
 
// C headers
 
// C++ headers
#include <cstddef>  // std::size_t
#include <ostream>  // ostream
#include <string>   // string
 
// Athena++ headers
#include "athena.hpp"
#include "defs.hpp"
#include "outputs/io_wrapper.hpp"
 
// OpenMP header
#ifdef OPENMP_PARALLEL
#include <omp.h>
#endif
 
//----------------------------------------------------------------------------------------
//  \brief  node in a singly linked list of parameters contained within 1x input block
 
struct InputLine {
  std::string param_name;
  std::string param_value;   // value of the parameter is stored as a string!
  std::string param_comment;
  InputLine *pnext;   // pointer to the next node in this nested singly linked list
};
 
//----------------------------------------------------------------------------------------
//  \brief node in a singly linked list of all input blocks contained within input file
 
class InputBlock {
 public:
  InputBlock() = default;
  ~InputBlock();
 
  // data
  std::string block_name;
  std::size_t max_len_parname;  // length of longest param_name, for nice-looking output
  std::size_t max_len_parvalue; // length of longest param_value, to format outputs
  InputBlock *pnext;  // pointer to the next node in InputBlock singly linked list
 
  InputLine *pline;   // pointer to head node in nested singly linked list (in this block)
  // (not storing a reference to the tail node)
 
  // functions
  InputLine* GetPtrToLine(std::string name);
};
 
//----------------------------------------------------------------------------------------
//  \brief data and definitions of functions used to store and access input parameters
//  Functions are implemented in parameter_input.cpp
 
class ParameterInput {
 public:
  // constructor/destructor
  ParameterInput();
  ~ParameterInput();
 
  // data
  InputBlock* pfirst_block;   // pointer to head node in singly linked list of InputBlock
  // (not storing a reference to the tail node)
 
  // functions
  void LoadFromStream(std::istream &is);
  void LoadFromFile(IOWrapper &input);
  void ModifyFromCmdline(int argc, char *argv[]);
  void ParameterDump(std::ostream& os);
  int  DoesParameterExist(std::string block, std::string name);
  int  GetInteger(std::string block, std::string name);
  int  GetOrAddInteger(std::string block, std::string name, int value);
  int  SetInteger(std::string block, std::string name, int value);
  Real GetReal(std::string block, std::string name);
  Real GetOrAddReal(std::string block, std::string name, Real value);
  Real SetReal(std::string block, std::string name, Real value);
  bool GetBoolean(std::string block, std::string name);
  bool GetOrAddBoolean(std::string block, std::string name, bool value);
  bool SetBoolean(std::string block, std::string name, bool value);
  std::string GetString(std::string block, std::string name);
  std::string GetOrAddString(std::string block, std::string name, std::string value);
  std::string SetString(std::string block, std::string name, std::string value);
  void RollbackNextTime();
  void ForwardNextTime(Real time);
  InputBlock* GetPtrToBlock(std::string name);
  void AddParameter(InputBlock *pib, std::string name, std::string value,
                    std::string comment);
 
 private:
  std::string last_filename_;  // last input file opened, to prevent duplicate reads
 
  InputBlock* FindOrAddBlock(std::string name);
  void ParseLine(InputBlock *pib, std::string line, std::string& name,
                 std::string& value, std::string& comment);
 
  // thread safety
#ifdef OPENMP_PARALLEL
  omp_lock_t lock_;
#endif
 
  void Lock();
  void Unlock();
};
#endif // PARAMETER_INPUT_HPP_