libMesh::Solver Class Reference

#include <solver.h>

Inheritance diagram for libMesh::Solver:

Public Types

typedef EquationSystems sys_type
 

Public Member Functions

 ~Solver ()
 
virtual void init ()
 
virtual void pre_process ()
 
virtual void solve ()
 
virtual void post_process ()
 
const sys_typesystem () const
 
const MeshBasemesh () const
 

Static Public Member Functions

static std::string get_info ()
 
static void print_info (std::ostream &out=libMesh::out)
 
static unsigned int n_objects ()
 
static void enable_print_counter_info ()
 
static void disable_print_counter_info ()
 

Protected Types

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

Protected Member Functions

 Solver (EquationSystems &es)
 
 Solver (EquationSystems &es, const std::string &name, const unsigned int number)
 
sys_typesystem ()
 
MeshBasemesh ()
 
void increment_constructor_count (const std::string &name)
 
void increment_destructor_count (const std::string &name)
 

Protected Attributes

sys_type_system
 
MeshBase_mesh
 

Static Protected Attributes

static Counts _counts
 
static Threads::atomic
< unsigned int > 
_n_objects
 
static Threads::spin_mutex _mutex
 
static bool _enable_print_counter = true
 

Detailed Description

This is a generic class that defines a solver to be used in a simulation. A user can define a solver by deriving from this class and implementing certain functions.

Author
Benjamin S. Kirk, 2003-2004.

Definition at line 47 of file solver.h.

Member Typedef Documentation

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 113 of file reference_counter.h.

The type of system

Definition at line 78 of file solver.h.

Constructor & Destructor Documentation

libMesh::Solver::Solver ( EquationSystems es)
inlineexplicitprotected

Constructor. Requires a reference to the system to be solved. The constructor is protected since it should not be instantiated by users.

Definition at line 145 of file solver.h.

145  :
146  _system (es),
147  _mesh (es.get_mesh())
148 {
149 libmesh_deprecated();
150 }
libMesh::Solver::Solver ( EquationSystems es,
const std::string &  name,
const unsigned int  number 
)
protected

Constructor. Requires a reference to the EquationSystems object, a name for the system, and the system number.

libMesh::Solver::~Solver ( )
inline

Destructor.

Definition at line 155 of file solver.h.

156 {
157 }

Member Function Documentation

void libMesh::ReferenceCounter::disable_print_counter_info ( )
staticinherited

Definition at line 106 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

107 {
108  _enable_print_counter = false;
109  return;
110 }
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.

References libMesh::ReferenceCounter::_enable_print_counter.

101 {
102  _enable_print_counter = true;
103  return;
104 }
std::string libMesh::ReferenceCounter::get_info ( )
staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

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

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

48 {
49 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
50 
51  std::ostringstream oss;
52 
53  oss << '\n'
54  << " ---------------------------------------------------------------------------- \n"
55  << "| Reference count information |\n"
56  << " ---------------------------------------------------------------------------- \n";
57 
58  for (Counts::iterator it = _counts.begin();
59  it != _counts.end(); ++it)
60  {
61  const std::string name(it->first);
62  const unsigned int creations = it->second.first;
63  const unsigned int destructions = it->second.second;
64 
65  oss << "| " << name << " reference count information:\n"
66  << "| Creations: " << creations << '\n'
67  << "| Destructions: " << destructions << '\n';
68  }
69 
70  oss << " ---------------------------------------------------------------------------- \n";
71 
72  return oss.str();
73 
74 #else
75 
76  return "";
77 
78 #endif
79 }
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 163 of file reference_counter.h.

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

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

164 {
165  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
166  std::pair<unsigned int, unsigned int>& p = _counts[name];
167 
168  p.first++;
169 }
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 176 of file reference_counter.h.

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

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

177 {
178  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
179  std::pair<unsigned int, unsigned int>& p = _counts[name];
180 
181  p.second++;
182 }
void libMesh::Solver::init ( )
inlinevirtual

The initialization function. This method is used to initialize data structures befor a simulation begins.

Definition at line 162 of file solver.h.

References libMesh::EquationSystems::init(), and system().

163 {
164  // Initialize the system.
165  this->system().init ();
166 }
const MeshBase& libMesh::Solver::mesh ( ) const
inline
Returns
a reference to the Mesh.

Definition at line 113 of file solver.h.

References _mesh.

113 { return _mesh; }
MeshBase& libMesh::Solver::mesh ( )
inlineprotected
Returns
a reference to the Mesh.

Definition at line 126 of file solver.h.

References _mesh.

126 { return _mesh; }
static unsigned int libMesh::ReferenceCounter::n_objects ( )
inlinestaticinherited

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

Definition at line 79 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

80  { return _n_objects; }
void libMesh::Solver::post_process ( )
inlinevirtual

This method may be called after each solve step in order to perform any required post-processing.

Definition at line 195 of file solver.h.

Referenced by solve().

196 {
197 // libMesh::out << "Post-processing"
198 // << std::endl;
199 }
void libMesh::Solver::pre_process ( )
inlinevirtual

This method may be called before each solve step in order to perform any required pre-processing.

Definition at line 171 of file solver.h.

Referenced by solve().

172 {
173 // libMesh::out << "Pre-processing"
174 // << std::endl;
175 }
void libMesh::ReferenceCounter::print_info ( std::ostream &  out = libMesh::out)
staticinherited

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

Definition at line 88 of file reference_counter.C.

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

89 {
91 }
void libMesh::Solver::solve ( )
inlinevirtual

This method performs a solve step. What occurs in this method will depend on the type of solver. See the example programs for more details.

Definition at line 180 of file solver.h.

References post_process(), pre_process(), libMesh::EquationSystems::solve(), and system().

181 {
182  // Perform any necessary pre-processing
184 
185  // Solve the system
186  this->system().solve ();
187 
188  // Perform any necessary post-processing
190 }
const sys_type& libMesh::Solver::system ( ) const
inline
Returns
a constant reference to the system we are solving.

Definition at line 108 of file solver.h.

References _system.

Referenced by init(), and solve().

108 { return _system; }
sys_type& libMesh::Solver::system ( )
inlineprotected
Returns
a writeable reference to the system we are solving.

Definition at line 121 of file solver.h.

References _system.

121 { return _system; }

Member Data Documentation

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts
staticprotectedinherited
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 137 of file reference_counter.h.

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

MeshBase& libMesh::Solver::_mesh
protected

A reference to the Mesh for the system we are solving.

Definition at line 137 of file solver.h.

Referenced by mesh().

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

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 131 of file reference_counter.h.

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 126 of file reference_counter.h.

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

sys_type& libMesh::Solver::_system
protected

A reference to the system we are solving.

Definition at line 131 of file solver.h.

Referenced by system().


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

Site Created By: libMesh Developers
Last modified: February 07 2014 16:58:02 UTC

Hosted By:
SourceForge.net Logo