time_stepping_parsing.C

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// GRINS - General Reacting Incompressible Navier-Stokes
//
// Copyright (C) 2014-2017 Paul T. Bauman, Roy H. Stogner
// Copyright (C) 2010-2013 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

// This class
#include "grins/time_stepping_parsing.h"

// GRINS
#include "grins/common.h"
#include "grins/solver_names.h"
#include "grins/solver_parsing.h"

// libMesh
#include "libmesh/getpot.h"

namespace GRINS
{
  unsigned int TimeSteppingParsing::parse_n_timesteps( const GetPot& input )
  {
    SolverParsing::dup_solver_option_check(input,
                                           "unsteady-solver/n_timesteps",
                                           "SolverOptions/TimeStepping/n_timesteps");

    unsigned int n_timesteps = 0;

    if( input.have_variable("unsteady-solver/n_timesteps") )
      {
        n_timesteps = input("unsteady-solver/n_timesteps",0);

        std::string warning = "WARNING: unsteady-solver/n_timesteps is DEPRECATED!\n";
        warning += "        Please use SolverOptions/TimeStepping/n_timesteps to specify # of timesteps.\n";
        grins_warning(warning);
      }
    else if( input.have_variable("SolverOptions/TimeStepping/n_timesteps") )
      n_timesteps = input("SolverOptions/TimeStepping/n_timesteps",0);
    else
      libmesh_error_msg("ERROR: Could not find valid entry for n_timesteps!");

    return n_timesteps;
  }

  unsigned int TimeSteppingParsing::parse_backtrack_deltat( const GetPot& input )
  {
    SolverParsing::dup_solver_option_check(input,
                                           "unsteady-solver/backtrack_deltat",
                                           "SolverOptions/TimeStepping/backtrack_deltat");

    unsigned int backtrack_deltat = 0;

    if( input.have_variable("unsteady-solver/backtrack_deltat") )
      {
        backtrack_deltat = input("unsteady-solver/backtrack_deltat",0);

        std::string warning = "WARNING: unsteady-solver/backtrack_deltat is DEPRECATED!\n";
        warning += "        Please use SolverOptions/TimeStepping/backtrack_deltat to set backtrack_deltat.\n";
        grins_warning(warning);
      }
    else
      backtrack_deltat = input("SolverOptions/TimeStepping/backtrack_deltat",0);

    return backtrack_deltat;
  }

  double TimeSteppingParsing::parse_theta( const GetPot& input )
  {
    double theta = 0.0;

    if( input.have_variable("unsteady-solver/theta") )
      {
        theta = input("unsteady-solver/theta",0.5);

        std::string warning = "WARNING: unsteady-solver/theta is DEPRECATED!\n";
        warning += "        Please use SolverOptions/TimeStepping/theta to set theta.\n";
        grins_warning(warning);
      }
    else
      theta = input("SolverOptions/TimeStepping/theta",0.5);

    if( theta < 0.0 || theta > 1.0 )
      {
        std::stringstream ts;
        ts << theta;
        libmesh_error_msg("ERROR: theta must be between 0.0 and 1.0. Found: "+ts.str());
      }

    return theta;
  }

  double TimeSteppingParsing::parse_deltat( const GetPot& input )
  {
    double delta_t = 0.0;

    if( input.have_variable("unsteady-solver/deltat") )
      {
        delta_t = input("unsteady-solver/deltat",0.0);

        std::string warning = "WARNING: unsteady-solver/deltat is DEPRECATED!\n";
        warning += "        Please use SolverOptions/TimeStepping/delta_t to set delta_t.\n";
        grins_warning(warning);
      }
    else if( input.have_variable("SolverOptions/TimeStepping/delta_t") )
      delta_t = input("SolverOptions/TimeStepping/delta_t",0.0);
    else
      libmesh_error_msg("ERROR: Could not find valid entry for delta_t!");

    return delta_t;
  }

  std::string TimeSteppingParsing::parse_time_stepper_name( const GetPot& input )
  {
    std::string default_stepper = SolverNames::libmesh_euler_solver();
    std::string time_stepper = default_stepper;

    // Before, we didn't actually set the solver name, we just set whether we
    // were transient or not. So, if we see this option was set to true, then
    // we were time stepping with the only option available then (EulerSolver)
    if( input("unsteady-solver/transient", false) )
      {
        std::string warning = "WARNING: using unsteady-solver options is DEPRECATED!\n";
        warning += "        Please use SolverOptions/TimeStepping/solver_type to set the time\n";
        warning += "        stepping algorithm.\n";
        grins_warning(warning);
      }
    else
      time_stepper = input("SolverOptions/TimeStepping/solver_type", default_stepper);

    return time_stepper;
  }

} // end namespace GRINS