libMesh
solver_configuration.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2017 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 
18 
19 
20 #ifndef LIBMESH_SOLVER_CONFIGURATION_H
21 #define LIBMESH_SOLVER_CONFIGURATION_H
22 
23 // Local includes
24 #include "libmesh/libmesh_common.h"
25 #include "libmesh/reference_counted_object.h"
26 
27 namespace libMesh
28 {
29 
39 class SolverConfiguration : public ReferenceCountedObject<SolverConfiguration>
40 {
41 public:
42 
47 
51  virtual ~SolverConfiguration () {}
52 
58  virtual void set_options_during_init() {}
59 
64  virtual void configure_solver() = 0;
65 
74  virtual void respond_to_solve_failure(unsigned int /*solve_failure_count*/)
75  {
76  libmesh_error_msg("Solver error"); // by default just throw an error
77  }
78 
82  std::map<std::string, Real> real_valued_data;
83 
87  std::map<std::string, int> int_valued_data;
88 
92  std::map<std::string, std::string> string_data;
93 
94 };
95 
96 } // namespace libMesh
97 
98 #endif // LIBMESH_SOLVER_CONFIGURATION_H
virtual void set_options_during_init()
Apply options during initialization of a solver.
virtual ~SolverConfiguration()
Destructor.
virtual void configure_solver()=0
Apply solver options to a particular solver.
The libMesh namespace provides an interface to certain functionality in the library.
std::map< std::string, Real > real_valued_data
Store real-valued solver parameters in this map, e.g.
virtual void respond_to_solve_failure(unsigned int)
This method can be called after the solver has failed (e.g.
std::map< std::string, int > int_valued_data
Store integer solver parameters in this map, e.g.
This class stores solver configuration data, e.g.
This class implements reference counting.
std::map< std::string, std::string > string_data
Store string data in this map, e.g.