solver_configuration.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2018 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_SOLVER_CONFIGURATION_H
#define LIBMESH_SOLVER_CONFIGURATION_H

// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/reference_counted_object.h"

namespace libMesh
{

class SolverConfiguration : public ReferenceCountedObject<SolverConfiguration>
{
public:

  SolverConfiguration () {}

  virtual ~SolverConfiguration () {}

  virtual void set_options_during_init() {}

  virtual void configure_solver() = 0;

  virtual void respond_to_solve_failure(unsigned int /*solve_failure_count*/)
  {
    libmesh_error_msg("Solver error"); // by default just throw an error
  }

  std::map<std::string, Real> real_valued_data;

  std::map<std::string, int> int_valued_data;

  std::map<std::string, std::string> string_data;

};

} // namespace libMesh

#endif // LIBMESH_SOLVER_CONFIGURATION_H