SlepcSolverConfiguration Class Reference

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)
	Constructor: get a reference to the SlepcEigenSolver variable to be able to manipulate it.
	~SlepcSolverConfiguration ()
	empty destructor
virtual void	configure_solver () override
	Apply solver options to a particular solver.
void	SetST (SpectralTransform st)
	This is the main functionality of this little class.
virtual void	set_options_during_init ()
	Apply options during initialization of a solver.
virtual void	respond_to_solve_failure (unsigned int)
	This method can be called after the solver has failed (e.g.

Static Public Member Functions
static std::string	get_info ()
	Gets a string containing the reference information.
static void	print_info (std::ostream &out_stream=libMesh::out)
	Prints the reference information, by default to libMesh::out.
static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects.
static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info().
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.
std::map< std::string, int >	int_valued_data
	Store integer solver parameters in this map, e.g.
std::map< std::string, std::string >	string_data
	Store string data in this map, e.g.

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

Protected Member Functions
void	increment_constructor_count (const std::string &name) noexcept
	Increments the construction counter.
void	increment_destructor_count (const std::string &name) noexcept
	Increments the destruction counter.

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

Private Attributes
libMesh::SlepcEigenSolver< libMesh::Number > &	_slepc_solver
	The linear solver object that we are configuring.
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 beneficial 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 119 of file reference_counter.h.

Constructor & Destructor Documentation

SlepcSolverConfiguration()

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

inline

Constructor: 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.

{}

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 677 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 _slepc_solver, _st, CAYLEY, libMesh::SlepcEigenSolver< T >::eps(), INVALID_ST, SHIFT, and SINVERT.

disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

{
  _enable_print_counter = false;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

Enabled by default.

Definition at line 94 of file reference_counter.C.

{
  _enable_print_counter = true;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

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

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 & [name, cd] : _counts)
    oss << "| " << name << " reference count information:\n"
        << "|  Creations:    " << cd.first    << '\n'
        << "|  Destructions: " << cd.second << '\n';
 
  oss << " ---------------------------------------------------------------------------- \n";
 
  return oss.str();
 
#else
 
  return "";
 
#endif
}

References libMesh::ReferenceCounter::_counts.

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

increment_constructor_count()

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

inlineprotectednoexceptinherited

Increments the construction counter.

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

Definition at line 183 of file reference_counter.h.

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.first++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_constructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), and libMesh::ReferenceCountedObject< T >::ReferenceCountedObject().

increment_destructor_count()

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

inlineprotectednoexceptinherited

Increments the destruction counter.

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

Definition at line 207 of file reference_counter.h.

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.second++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_destructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::~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 85 of file reference_counter.h.

  { return _n_objects; }

References libMesh::ReferenceCounter::_n_objects.

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

print_info()

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

staticinherited

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

Definition at line 81 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().

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

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.

{}

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.

  { _st=st;}

References _st.

Member Data Documentation

_counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

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

_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 143 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 137 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 132 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), libMesh::ReferenceCounter::ReferenceCounter(), 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.

Referenced by configure_solver().

_st

SpectralTransform SlepcSolverConfiguration::_st

private

Definition at line 121 of file miscellaneous_ex14.C.

Referenced by configure_solver(), and SetST().

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