libMesh
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Static Protected Attributes | List of all members
libMesh::SolverConfiguration Class Referenceabstract

This class stores solver configuration data, e.g. More...

#include <solver_configuration.h>

Inheritance diagram for libMesh::SolverConfiguration:
[legend]

Public Member Functions

 SolverConfiguration ()
 Constructor. More...
 
virtual ~SolverConfiguration ()
 Destructor. More...
 
virtual void set_options_during_init ()
 Apply options during initialization of a solver. More...
 
virtual void configure_solver ()=0
 Apply solver options to a particular solver. More...
 
virtual void respond_to_solve_failure (unsigned int)
 This method can be called after the solver has failed (e.g. More...
 

Static Public Member Functions

static std::string get_info ()
 Gets a string containing the reference information. More...
 
static void print_info (std::ostream &out=libMesh::out)
 Prints the reference information, by default to libMesh::out. More...
 
static unsigned int n_objects ()
 Prints the number of outstanding (created, but not yet destroyed) objects. More...
 
static void enable_print_counter_info ()
 Methods to enable/disable the reference counter output from print_info() More...
 
static void disable_print_counter_info ()
 

Public Attributes

std::map< std::string, Realreal_valued_data
 Store real-valued solver parameters in this map, e.g. More...
 
std::map< std::string, int > int_valued_data
 Store integer solver parameters in this map, e.g. More...
 
std::map< std::string, std::string > string_data
 Store string data in this map, e.g. More...
 

Protected Types

typedef std::map< std::string, std::pair< unsigned int, unsigned int > > Counts
 Data structure to log the information. More...
 

Protected Member Functions

void increment_constructor_count (const std::string &name)
 Increments the construction counter. More...
 
void increment_destructor_count (const std::string &name)
 Increments the destruction counter. More...
 

Static Protected Attributes

static Counts _counts
 Actually holds the data. More...
 
static Threads::atomic< unsigned int > _n_objects
 The number of objects. More...
 
static Threads::spin_mutex _mutex
 Mutual exclusion object to enable thread-safe reference counting. More...
 
static bool _enable_print_counter
 Flag to control whether reference count information is printed when print_info is called. More...
 

Detailed Description

This class stores solver configuration data, e.g.

tolerances and iteration limits. Override the pure virtual function configure_solver() in order to provide specific behavior for particular types of solvers (e.g. LinearSolver, EigenSolver, etc).

Author
David Knezevic
Date
2015

Definition at line 39 of file solver_configuration.h.

Member Typedef Documentation

◆ Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts
protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

Constructor & Destructor Documentation

◆ SolverConfiguration()

libMesh::SolverConfiguration::SolverConfiguration ( )

Constructor.

Definition at line 46 of file solver_configuration.h.

46 {}

◆ ~SolverConfiguration()

virtual libMesh::SolverConfiguration::~SolverConfiguration ( )
virtual

Destructor.

Definition at line 51 of file solver_configuration.h.

51 {}

Member Function Documentation

◆ configure_solver()

virtual void libMesh::SolverConfiguration::configure_solver ( )
pure virtual

Apply solver options to a particular solver.

Override in subclasses to provide specific behavior.

◆ disable_print_counter_info()

static void libMesh::ReferenceCounter::disable_print_counter_info ( )
staticinherited

◆ enable_print_counter_info()

static void libMesh::ReferenceCounter::enable_print_counter_info ( )
staticinherited

Methods to enable/disable the reference counter output from print_info()

◆ get_info()

static std::string libMesh::ReferenceCounter::get_info ( )
staticinherited

Gets a string containing the reference information.

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string &  name)
protectedinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 181 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

182 {
183  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
184  std::pair<unsigned int, unsigned int> & p = _counts[name];
185 
186  p.first++;
187 }
std::string name(const ElemQuality q)
static Counts _counts
Actually holds the data.
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string &  name)
protectedinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 194 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

195 {
196  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
197  std::pair<unsigned int, unsigned int> & p = _counts[name];
198 
199  p.second++;
200 }
std::string name(const ElemQuality q)
static Counts _counts
Actually holds the data.
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )
staticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84  { return _n_objects; }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

◆ print_info()

static void libMesh::ReferenceCounter::print_info ( std::ostream &  out = libMesh::out)
staticinherited

Prints the reference information, by default to libMesh::out.

◆ respond_to_solve_failure()

virtual void libMesh::SolverConfiguration::respond_to_solve_failure ( unsigned  int)
virtual

This method can be called after the solver has failed (e.g.

on catching an exception thrown by a solver). It allows an appropriate response to the failure, e.g. terminate the program, or change configuration options and try again. solve_failure_count specifies the number of times we've tried to recover from a failure.

Definition at line 74 of file solver_configuration.h.

75  {
76  libmesh_error_msg("Solver error"); // by default just throw an error
77  }

◆ set_options_during_init()

virtual void libMesh::SolverConfiguration::set_options_during_init ( )
virtual

Apply options during initialization of a solver.

Default is a no-op. Override in subclasses to provide specific behavior.

Definition at line 58 of file solver_configuration.h.

58 {}

Member Data Documentation

◆ _counts

Counts libMesh::ReferenceCounter::_counts
staticprotectedinherited

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter
staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex
staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects

Threads::atomic<unsigned int> libMesh::ReferenceCounter::_n_objects
staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ int_valued_data

std::map<std::string, int> libMesh::SolverConfiguration::int_valued_data

Store integer solver parameters in this map, e.g.

iteration limits.

Definition at line 87 of file solver_configuration.h.

◆ real_valued_data

std::map<std::string, Real> libMesh::SolverConfiguration::real_valued_data

Store real-valued solver parameters in this map, e.g.

solver tolerances.

Definition at line 82 of file solver_configuration.h.

◆ string_data

std::map<std::string, std::string> libMesh::SolverConfiguration::string_data

Store string data in this map, e.g.

"solver_type" : "gmres".

Definition at line 92 of file solver_configuration.h.


The documentation for this class was generated from the following file: