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

#include <solver_configuration.h>

Inheritance diagram for libMesh::SolverConfiguration:

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, Real >	real_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 = true
	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 ( )

inline

Constructor.

Definition at line 46 of file solver_configuration.h.

46 {}

◆ ~SolverConfiguration()

virtual libMesh::SolverConfiguration::~SolverConfiguration ( )

inlinevirtual

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.

Implemented in SlepcSolverConfiguration, and PetscSolverConfiguration.

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 106 of file reference_counter.C.

 {
   _enable_print_counter = false;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::LibMeshInit().

◆ enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

Definition at line 100 of file reference_counter.C.

 {
   _enable_print_counter = true;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

◆ get_info()

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

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
  
   std::ostringstream oss;
  
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
  
   for (const auto & pr : _counts)
     {
       const std::string name(pr.first);
       const unsigned int creations    = pr.second.first;
       const unsigned int destructions = pr.second.second;
  
       oss << "| " << name << " reference count information:\n"
           << "|  Creations:    " << creations    << '\n'
           << "|  Destructions: " << destructions << '\n';
     }
  
   oss << " ---------------------------------------------------------------------------- \n";
  
   return oss.str();
  
 #else
  
   return "";
  
 #endif
 }

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

Referenced by libMesh::ReferenceCounter::print_info().

◆ increment_constructor_count()

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

inlineprotectedinherited

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.

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
  
   p.first++;
 }

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

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

◆ increment_destructor_count()

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

inlineprotectedinherited

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.

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
  
   p.second++;
 }

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

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

◆ n_objects()

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

inlinestaticinherited

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

Definition at line 83 of file reference_counter.h.

84 { return _n_objects; }

References libMesh::ReferenceCounter::_n_objects.

◆ print_info()

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

staticinherited

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

Definition at line 87 of file reference_counter.C.

 {
   if (_enable_print_counter)
     out_stream << ReferenceCounter::get_info();
 }

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

◆ respond_to_solve_failure()

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

inlinevirtual

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.

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

◆ set_options_during_init()

virtual void libMesh::SolverConfiguration::set_options_during_init ( )

inlinevirtual

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

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info(), libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

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

Definition at line 141 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

◆ _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:

include/solvers/solver_configuration.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Counts

Constructor & Destructor Documentation

◆ SolverConfiguration()

◆ ~SolverConfiguration()

Member Function Documentation

◆ configure_solver()

◆ disable_print_counter_info()

◆ enable_print_counter_info()

◆ get_info()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ n_objects()

◆ print_info()

◆ respond_to_solve_failure()

◆ set_options_during_init()

Member Data Documentation

◆ _counts

◆ _enable_print_counter

◆ _mutex

◆ _n_objects

◆ int_valued_data

◆ real_valued_data

◆ string_data