A class that interfaces the SolverConfiguration to add the SLEPC option SetST. More...

Inheritance diagram for SlepcSolverConfiguration:

Public Member Functions
	SlepcSolverConfiguration (libMesh::SlepcEigenSolver< libMesh::Number > &slepc_eigen_solver)
	Constructur: get a reference to the `SlepcEigenSolver` variable to be able to manipulate it. More...

	~SlepcSolverConfiguration ()
	empty destructor More...

virtual void	configure_solver () override
	Apply solver options to a particular solver. More...

void	SetST (SpectralTransform st)
	This is the main functionality of this little class. More...

virtual void	set_options_during_init ()
	Apply options during initialization of a 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...

Private Attributes
libMesh::SlepcEigenSolver< libMesh::Number > &	_slepc_solver
	The linear solver object that we are configuring. More...

SpectralTransform	_st

Detailed Description

A class that interfaces the SolverConfiguration to add the SLEPC option SetST.

In case of dense eigenvalues, the application of SINVERT or CAYLEY is highly benefitial see the SLEPC-manual for details.

Definition at line 90 of file miscellaneous_ex14.C.

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

◆ SlepcSolverConfiguration()

SlepcSolverConfiguration::SlepcSolverConfiguration ( libMesh::SlepcEigenSolver< libMesh::Number > & slepc_eigen_solver )

inline

Constructur: get a reference to the SlepcEigenSolver variable to be able to manipulate it.

Definition at line 97 of file miscellaneous_ex14.C.

                                                                                        :
     _slepc_solver(slepc_eigen_solver),
     _st(INVALID_ST)
   {}

◆ ~SlepcSolverConfiguration()

SlepcSolverConfiguration::~SlepcSolverConfiguration ( )

inline

empty destructor

Definition at line 105 of file miscellaneous_ex14.C.

105 {}

Member Function Documentation

◆ configure_solver()

void SlepcSolverConfiguration::configure_solver ( )

overridevirtual

Apply solver options to a particular solver.

Override in subclasses to provide specific behavior.

Implements libMesh::SolverConfiguration.

Definition at line 680 of file miscellaneous_ex14.C.

 {
   // if a spectral transformation was requested
   if (_st!=INVALID_ST)
     {
       // initialise the st with the default values and change the spectral transformation value.
       ST st;
       PetscErrorCode ierr = EPSGetST(_slepc_solver.eps(), &st);
       if (ierr)
         libmesh_error();
  
       // Set it to the desired type of spectral transformation.
       // The value of the respective shift is chosen to be the target
       // specified via \p set_position_of_spectrum().
       switch (_st)
         {
         case SHIFT:
           ierr = STSetType(st, STSHIFT);
           break;
         case SINVERT:
           // this method has been renamed in 3.1
 #if SLEPC_VERSION_LESS_THAN(3,1,0)
           ierr = STSetType(st, STSINV);
 #else
           ierr = STSetType(st, STSINVERT);
 #endif
           break;
         case CAYLEY:
           ierr = STSetType(st, STCAYLEY);
           break;
         default:
           // print a warning but do nothing more.
           break;
         }
       if (ierr)
         libmesh_error();
  
       // since st is a reference to the particular object used by \p _slepc_solver,
       // we don't need to hand back the manipulated object. It will be applied before
       // solving the system automatically.
     }
 }

References CAYLEY, libMesh::ierr, INVALID_ST, SHIFT, and SINVERT.

◆ 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 )

inlinevirtualinherited

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 ( )

inlinevirtualinherited

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 {}

◆ SetST()

void SlepcSolverConfiguration::SetST ( SpectralTransform st )

inline

This is the main functionality of this little class.

Definition at line 112 of file miscellaneous_ex14.C.

113 { _st=st;}

Referenced by main().

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().

◆ _slepc_solver

libMesh::SlepcEigenSolver<libMesh::Number>& SlepcSolverConfiguration::_slepc_solver

private

The linear solver object that we are configuring.

Definition at line 120 of file miscellaneous_ex14.C.

◆ _st

SpectralTransform SlepcSolverConfiguration::_st

private

Definition at line 121 of file miscellaneous_ex14.C.

◆ int_valued_data

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

inherited

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

inherited

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

inherited

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:

examples/miscellaneous/miscellaneous_ex14/miscellaneous_ex14.C

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Counts

Constructor & Destructor Documentation

◆ SlepcSolverConfiguration()

◆ ~SlepcSolverConfiguration()

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()

◆ SetST()

Member Data Documentation

◆ _counts

◆ _enable_print_counter

◆ _mutex

◆ _n_objects

◆ _slepc_solver

◆ _st

◆ int_valued_data

◆ real_valued_data

◆ string_data