The name of this class is confusing...it's meant to refer to the base class (TimeSolver) while still telling one that it's for solving (generalized) EigenValue problems that arise from finite element discretizations. More...

#include <eigen_time_solver.h>

Inheritance diagram for libMesh::EigenTimeSolver:

[legend]

Public Types
typedef DifferentiableSystem	sys_type
	The type of system. More...

typedef TimeSolver	Parent
	The parent class. More...

Public Member Functions
	EigenTimeSolver (sys_type &s)
	Constructor. More...

virtual	~EigenTimeSolver ()
	Destructor. More...

virtual void	init () override
	The initialization function. More...

virtual void	reinit () override
	The reinitialization function. More...

virtual void	solve () override
	Implements the assembly of both matrices A and B, and calls the EigenSolver to compute the eigenvalues. More...

virtual void	advance_timestep () override
	It doesn't make sense to advance the timestep, so we shouldn't call this. More...

Real	error_order () const
	error convergence order against deltat is not applicable to an eigenvalue problem. More...

virtual bool	element_residual (bool get_jacobian, DiffContext &) override
	Forms either the spatial (Jacobian) or mass matrix part of the operator, depending on which is requested. More...

virtual bool	side_residual (bool get_jacobian, DiffContext &) override
	Forms the jacobian of the boundary terms. More...

virtual bool	nonlocal_residual (bool get_jacobian, DiffContext &) override
	Forms the jacobian of the nonlocal terms. More...

virtual Real	du (const SystemNorm &) const override

virtual bool	is_steady () const override
	This is effectively a steady-state solver. More...

virtual void	init_data ()
	The data initialization function. More...

virtual void	adjoint_advance_timestep ()
	This method advances the adjoint solution to the previous timestep, after an adjoint_solve() has been performed. More...

virtual void	retrieve_timestep ()
	This method retrieves all the stored solutions at the current system.time. More...

virtual void	before_timestep ()
	This method is for subclasses or users to override to do arbitrary processing between timesteps. More...

const sys_type &	system () const

sys_type &	system ()

virtual std::unique_ptr< DiffSolver > &	diff_solver ()
	An implicit linear or nonlinear solver to use at each timestep. More...

virtual std::unique_ptr< LinearSolver< Number > > &	linear_solver ()
	An implicit linear solver to use for adjoint and sensitivity problems. More...

void	set_solution_history (const SolutionHistory &_solution_history)
	A setter function users will employ if they need to do something other than save no solution history. More...

bool	is_adjoint () const
	Accessor for querying whether we need to do a primal or adjoint solve. More...

void	set_is_adjoint (bool _is_adjoint_value)
	Accessor for setting whether we need to do a primal or adjoint solve. 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::unique_ptr< EigenSolver< Number > >	eigen_solver
	The EigenSolver object. More...

Real	tol
	The linear solver tolerance to be used when solving the eigenvalue problem. More...

unsigned int	maxits
	The maximum number of iterations allowed to solve the problem. More...

unsigned int	n_eigenpairs_to_compute
	The number of eigenvectors/values to be computed. More...

unsigned int	n_basis_vectors_to_use
	The number of basis vectors to use in the computation. More...

unsigned int	n_converged_eigenpairs
	After a solve, holds the number of eigenpairs successfully converged. More...

unsigned int	n_iterations_reqd
	After a solve, holds the number of iterations required to converge the requested number of eigenpairs. More...

bool	quiet
	Print extra debugging information if quiet == false. More...

unsigned int	reduce_deltat_on_diffsolver_failure
	This value (which defaults to zero) is the number of times the TimeSolver is allowed to halve deltat and let the DiffSolver repeat the latest failed solve with a reduced timestep. More...

Protected Types
typedef bool(DifferentiablePhysics::*	ResFuncType) (bool, DiffContext &)
	Definitions of argument types for use in refactoring subclasses. More...

typedef void(DiffContext::*	ReinitFuncType) (Real)

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

Protected Attributes
std::unique_ptr< DiffSolver >	_diff_solver
	An implicit linear or nonlinear solver to use at each timestep. More...

std::unique_ptr< LinearSolver< Number > >	_linear_solver
	An implicit linear solver to use for adjoint problems. More...

sys_type &	_system
	A reference to the system we are solving. More...

std::unique_ptr< SolutionHistory >	solution_history
	A std::unique_ptr to a SolutionHistory object. 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...

Private Types
enum	NowAssembling { Matrix_A, Matrix_B, Invalid_Matrix }

Private Attributes
NowAssembling	now_assembling
	Flag which controls the internals of element_residual() and side_residual(). More...

Detailed Description

The name of this class is confusing...it's meant to refer to the base class (TimeSolver) while still telling one that it's for solving (generalized) EigenValue problems that arise from finite element discretizations.

For a time-dependent problem du/dt=F(u), with a steady solution 0=F(u_0), we look at the time evolution of a small perturbation, p=u-u_0, for which the (linearized) governing equation is

dp/dt = F'(u_0)p

where F'(u_0) is the Jacobian. The generalized eigenvalue problem arises by considering perturbations of the general form p = exp(lambda*t)x, which leads to

Ax = lambda*Bx

where A is the (discretized by FEM) Jacobian matrix and B is the (discretized by FEM) mass matrix.

The EigenSystem class (by Steffen Petersen) is related but does not fall under the FEMSystem paradigm invented by Roy Stogner. The EigenSolver class (also by Steffen) is meant to provide a generic "linear solver" interface for EigenValue software. The only current concrete implementation is a SLEPc-based eigensolver class, which we make use of here as well.

Author: John W. Peterson

Date: 2007

Definition at line 66 of file eigen_time_solver.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.

◆ Parent

typedef TimeSolver libMesh::EigenTimeSolver::Parent

The parent class.

Definition at line 77 of file eigen_time_solver.h.

◆ ReinitFuncType

typedef void(DiffContext::* libMesh::TimeSolver::ReinitFuncType) (Real)

protectedinherited

Definition at line 273 of file time_solver.h.

◆ ResFuncType

typedef bool(DifferentiablePhysics::* libMesh::TimeSolver::ResFuncType) (bool, DiffContext &)

protectedinherited

Definitions of argument types for use in refactoring subclasses.

Definition at line 271 of file time_solver.h.

◆ sys_type

typedef DifferentiableSystem libMesh::EigenTimeSolver::sys_type

The type of system.

Definition at line 72 of file eigen_time_solver.h.

Member Enumeration Documentation

◆ NowAssembling

enum libMesh::EigenTimeSolver::NowAssembling

private

Enumerator
Matrix_A	The matrix associated with the spatial part of the operator.
Matrix_B	The matrix associated with the time derivative (mass matrix).
Invalid_Matrix	The enum is in an invalid state.

Definition at line 198 of file eigen_time_solver.h.

                      {
     Matrix_A,
 
     Matrix_B,
 
     Invalid_Matrix
   };

Constructor & Destructor Documentation

◆ EigenTimeSolver()

libMesh::EigenTimeSolver::EigenTimeSolver ( sys_type & s )

explicit

Constructor.

Requires a reference to the system to be solved.

◆ ~EigenTimeSolver()

virtual libMesh::EigenTimeSolver::~EigenTimeSolver ( )

virtual

Destructor.

Member Function Documentation

◆ adjoint_advance_timestep()

virtual void libMesh::TimeSolver::adjoint_advance_timestep ( )

virtualinherited

This method advances the adjoint solution to the previous timestep, after an adjoint_solve() has been performed.

This will be done before every UnsteadySolver::adjoint_solve().

Reimplemented in libMesh::UnsteadySolver, and libMesh::NewmarkSolver.

◆ advance_timestep()

virtual void libMesh::EigenTimeSolver::advance_timestep ( )

overridevirtual

It doesn't make sense to advance the timestep, so we shouldn't call this.

Reimplemented from libMesh::TimeSolver.

Definition at line 112 of file eigen_time_solver.h.

112 {}

◆ before_timestep()

virtual void libMesh::TimeSolver::before_timestep ( )

virtualinherited

This method is for subclasses or users to override to do arbitrary processing between timesteps.

Definition at line 167 of file time_solver.h.

167 {}

◆ diff_solver()

virtual std::unique_ptr<DiffSolver>& libMesh::TimeSolver::diff_solver ( )

virtualinherited

An implicit linear or nonlinear solver to use at each timestep.

Reimplemented in libMesh::AdaptiveTimeSolver.

Definition at line 182 of file time_solver.h.

References libMesh::TimeSolver::_diff_solver.

182 { return _diff_solver; }

libMesh::TimeSolver::_diff_solver

std::unique_ptr< DiffSolver > _diff_solver

An implicit linear or nonlinear solver to use at each timestep.

Definition: time_solver.h:248

◆ disable_print_counter_info()

static void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

◆ du()

virtual Real libMesh::EigenTimeSolver::du ( const SystemNorm & ) const

overridevirtual

Returns: 0, but derived classes should override this function to compute the size of the difference between successive solution iterates ||u^{n+1} - u^{n}|| in some norm.

Implements libMesh::TimeSolver.

Definition at line 144 of file eigen_time_solver.h.

144 { return 0.; }

◆ element_residual()

virtual bool libMesh::EigenTimeSolver::element_residual	(	bool	get_jacobian,
		DiffContext &
	)

overridevirtual

Forms either the spatial (Jacobian) or mass matrix part of the operator, depending on which is requested.

Implements libMesh::TimeSolver.

◆ enable_print_counter_info()

static void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

◆ error_order()

Real libMesh::EigenTimeSolver::error_order ( ) const

error convergence order against deltat is not applicable to an eigenvalue problem.

Definition at line 118 of file eigen_time_solver.h.

118 { return 0.; }

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

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

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

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

◆ init()

virtual void libMesh::EigenTimeSolver::init ( )

overridevirtual

The initialization function.

This method is used to initialize internal data structures before a simulation begins.

Reimplemented from libMesh::TimeSolver.

◆ init_data()

virtual void libMesh::TimeSolver::init_data ( )

virtualinherited

The data initialization function.

This method is used to initialize internal data structures after the underlying System has been initialized

Reimplemented in libMesh::UnsteadySolver, and libMesh::SecondOrderUnsteadySolver.

◆ is_adjoint()

bool libMesh::TimeSolver::is_adjoint ( ) const

inherited

Accessor for querying whether we need to do a primal or adjoint solve.

Definition at line 233 of file time_solver.h.

References libMesh::TimeSolver::_is_adjoint.

234 { return _is_adjoint; }

libMesh::TimeSolver::_is_adjoint

bool _is_adjoint

This boolean tells the TimeSolver whether we are solving a primal or adjoint problem.

Definition: time_solver.h:281

◆ is_steady()

virtual bool libMesh::EigenTimeSolver::is_steady ( ) const

overridevirtual

This is effectively a steady-state solver.

Implements libMesh::TimeSolver.

Definition at line 149 of file eigen_time_solver.h.

149 { return true; }

◆ linear_solver()

virtual std::unique_ptr<LinearSolver<Number> >& libMesh::TimeSolver::linear_solver ( )

virtualinherited

An implicit linear solver to use for adjoint and sensitivity problems.

Reimplemented in libMesh::AdaptiveTimeSolver.

Definition at line 187 of file time_solver.h.

References libMesh::TimeSolver::_linear_solver.

187 { return _linear_solver; }

libMesh::TimeSolver::_linear_solver

std::unique_ptr< LinearSolver< Number > > _linear_solver

An implicit linear solver to use for adjoint problems.

Definition: time_solver.h:253

◆ 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; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:130

◆ nonlocal_residual()

virtual bool libMesh::EigenTimeSolver::nonlocal_residual	(	bool	get_jacobian,
		DiffContext &
	)

overridevirtual

Forms the jacobian of the nonlocal terms.

Implements libMesh::TimeSolver.

◆ print_info()

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

staticinherited

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

◆ reinit()

virtual void libMesh::EigenTimeSolver::reinit ( )

overridevirtual

The reinitialization function.

This method is used after changes in the mesh

Reimplemented from libMesh::TimeSolver.

◆ retrieve_timestep()

virtual void libMesh::TimeSolver::retrieve_timestep ( )

virtualinherited

This method retrieves all the stored solutions at the current system.time.

Reimplemented in libMesh::UnsteadySolver, and libMesh::SecondOrderUnsteadySolver.

◆ set_is_adjoint()

void libMesh::TimeSolver::set_is_adjoint ( bool _is_adjoint_value )

inherited

Accessor for setting whether we need to do a primal or adjoint solve.

Definition at line 240 of file time_solver.h.

References libMesh::TimeSolver::_is_adjoint.

241 { _is_adjoint = _is_adjoint_value; }

libMesh::TimeSolver::_is_adjoint

bool _is_adjoint

This boolean tells the TimeSolver whether we are solving a primal or adjoint problem.

Definition: time_solver.h:281

◆ set_solution_history()

void libMesh::TimeSolver::set_solution_history ( const SolutionHistory & _solution_history )

inherited

A setter function users will employ if they need to do something other than save no solution history.

◆ side_residual()

virtual bool libMesh::EigenTimeSolver::side_residual	(	bool	get_jacobian,
		DiffContext &
	)

overridevirtual

Forms the jacobian of the boundary terms.

Implements libMesh::TimeSolver.

◆ solve()

virtual void libMesh::EigenTimeSolver::solve ( )

overridevirtual

Implements the assembly of both matrices A and B, and calls the EigenSolver to compute the eigenvalues.

Reimplemented from libMesh::TimeSolver.

◆ system() [1/2]

const sys_type& libMesh::TimeSolver::system ( ) const

inherited

Returns: A constant reference to the system we are solving.

Definition at line 172 of file time_solver.h.

References libMesh::TimeSolver::_system.

172 { return _system; }

libMesh::TimeSolver::_system

sys_type & _system

A reference to the system we are solving.

Definition: time_solver.h:258

◆ system() [2/2]

sys_type& libMesh::TimeSolver::system ( )

inherited

Returns: A writable reference to the system we are solving.

Definition at line 177 of file time_solver.h.

References libMesh::TimeSolver::_system.

177 { return _system; }

libMesh::TimeSolver::_system

sys_type & _system

A reference to the system we are solving.

Definition: time_solver.h:258

Member Data Documentation

◆ _counts

Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

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

◆ _diff_solver

std::unique_ptr<DiffSolver> libMesh::TimeSolver::_diff_solver

protectedinherited

An implicit linear or nonlinear solver to use at each timestep.

Definition at line 248 of file time_solver.h.

Referenced by libMesh::TimeSolver::diff_solver().

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

◆ _linear_solver

std::unique_ptr<LinearSolver<Number> > libMesh::TimeSolver::_linear_solver

protectedinherited

An implicit linear solver to use for adjoint problems.

Definition at line 253 of file time_solver.h.

Referenced by libMesh::TimeSolver::linear_solver().

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

◆ _system

sys_type& libMesh::TimeSolver::_system

protectedinherited

A reference to the system we are solving.

Definition at line 258 of file time_solver.h.

Referenced by libMesh::TimeSolver::system().

◆ eigen_solver

std::unique_ptr<EigenSolver<Number> > libMesh::EigenTimeSolver::eigen_solver

The EigenSolver object.

This is what actually makes the calls to SLEPc.

Definition at line 155 of file eigen_time_solver.h.

◆ maxits

unsigned int libMesh::EigenTimeSolver::maxits

The maximum number of iterations allowed to solve the problem.

Definition at line 166 of file eigen_time_solver.h.

◆ n_basis_vectors_to_use

unsigned int libMesh::EigenTimeSolver::n_basis_vectors_to_use

The number of basis vectors to use in the computation.

According to ex16, the number of basis vectors must be >= the number of eigenpairs requested, and ncv >= 2*nev is recommended. Increasing this number, even by a little bit, can greatly reduce the number of (EigenSolver) iterations required to compute the desired number of eigenpairs, but the cost per iteration goes up drastically as well.

Definition at line 182 of file eigen_time_solver.h.

◆ n_converged_eigenpairs

unsigned int libMesh::EigenTimeSolver::n_converged_eigenpairs

After a solve, holds the number of eigenpairs successfully converged.

Definition at line 188 of file eigen_time_solver.h.

◆ n_eigenpairs_to_compute

unsigned int libMesh::EigenTimeSolver::n_eigenpairs_to_compute

The number of eigenvectors/values to be computed.

Definition at line 171 of file eigen_time_solver.h.

◆ n_iterations_reqd

unsigned int libMesh::EigenTimeSolver::n_iterations_reqd

After a solve, holds the number of iterations required to converge the requested number of eigenpairs.

Definition at line 194 of file eigen_time_solver.h.

◆ now_assembling

NowAssembling libMesh::EigenTimeSolver::now_assembling

private

Flag which controls the internals of element_residual() and side_residual().

Definition at line 218 of file eigen_time_solver.h.

◆ quiet

bool libMesh::TimeSolver::quiet

inherited

Print extra debugging information if quiet == false.

Definition at line 192 of file time_solver.h.

◆ reduce_deltat_on_diffsolver_failure

unsigned int libMesh::TimeSolver::reduce_deltat_on_diffsolver_failure

inherited

This value (which defaults to zero) is the number of times the TimeSolver is allowed to halve deltat and let the DiffSolver repeat the latest failed solve with a reduced timestep.

Note: This has no effect for SteadySolvers.; You must set at least one of the DiffSolver flags "continue_after_max_iterations" or "continue_after_backtrack_failure" to allow the TimeSolver to retry the solve.

Definition at line 221 of file time_solver.h.

◆ solution_history

std::unique_ptr<SolutionHistory> libMesh::TimeSolver::solution_history

protectedinherited

A std::unique_ptr to a SolutionHistory object.

Default is NoSolutionHistory, which the user can override by declaring a different kind of SolutionHistory in the application

Definition at line 265 of file time_solver.h.

◆ tol

Real libMesh::EigenTimeSolver::tol

The linear solver tolerance to be used when solving the eigenvalue problem.

FIXME: need more info...

Definition at line 161 of file eigen_time_solver.h.

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

include/solvers/eigen_time_solver.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Counts

◆ Parent

◆ ReinitFuncType

◆ ResFuncType

◆ sys_type

Member Enumeration Documentation

◆ NowAssembling

Constructor & Destructor Documentation

◆ EigenTimeSolver()

◆ ~EigenTimeSolver()

Member Function Documentation

◆ adjoint_advance_timestep()

◆ advance_timestep()

◆ before_timestep()

◆ diff_solver()

◆ disable_print_counter_info()

◆ du()

◆ element_residual()

◆ enable_print_counter_info()

◆ error_order()

◆ get_info()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ init()

◆ init_data()

◆ is_adjoint()

◆ is_steady()

◆ linear_solver()

◆ n_objects()

◆ nonlocal_residual()

◆ print_info()

◆ reinit()

◆ retrieve_timestep()

◆ set_is_adjoint()

◆ set_solution_history()

◆ side_residual()

◆ solve()

◆ system() [1/2]

◆ system() [2/2]

Member Data Documentation

◆ _counts

◆ _diff_solver

◆ _enable_print_counter

◆ _linear_solver

◆ _mutex

◆ _n_objects

◆ _system

◆ eigen_solver

◆ maxits

◆ n_basis_vectors_to_use

◆ n_converged_eigenpairs

◆ n_eigenpairs_to_compute

◆ n_iterations_reqd

◆ now_assembling

◆ quiet

◆ reduce_deltat_on_diffsolver_failure

◆ solution_history

◆ tol