suanPan
Public Member Functions | List of all members
Frequency Class Referencefinal
Step

A Frequency class. More...

#include <Frequency.h>

Inheritance diagram for Frequency:
Collaboration diagram for Frequency:

Public Member Functions

 Frequency (unsigned=0, unsigned=4, char='S')
 
int initialize () override
 
int analyze () override
 
void set_eigen_number (unsigned) const
 
unsigned get_eigen_number () const
 
- Public Member Functions inherited from Step
 Step (unsigned=0, double=1.)
 
 Step (const Step &)=delete
 
 Step (Step &&) noexcept=delete
 
Step & operator= (const Step &)=delete
 
Step & operator= (Step &&) noexcept=delete
 
 ~Step () override=default
 
virtual int initialize ()
 
virtual int analyze ()=0
 
void set_domain (const weak_ptr< DomainBase > &)
 
const weak_ptr< DomainBase > & get_domain () const
 
void set_factory (const shared_ptr< Factory< double > > &)
 
const shared_ptr< Factory< double > > & get_factory () const
 
void set_solver_tag (unsigned)
 
void set_solver (const shared_ptr< Solver > &)
 
const shared_ptr< Solver > & get_solver () const
 
void set_converger_tag (unsigned)
 
void set_converger (const shared_ptr< Converger > &)
 
const shared_ptr< Converger > & get_converger () const
 
void set_integrator_tag (unsigned)
 
void set_integrator (const shared_ptr< Integrator > &)
 
const shared_ptr< Integrator > & get_integrator () const
 
void set_time_period (double)
 
void set_time_left (double)
 
double get_time_period () const
 
double get_time_left () const
 
void set_ini_step_size (double)
 
void set_min_step_size (double)
 
void set_max_step_size (double)
 
void set_max_substep (unsigned)
 
void set_system_solver (SolverType)
 
void set_system_solver (IterativeSolver)
 
void set_sub_system_solver (SolverType)
 
void set_preconditioner (PreconditionerType)
 
void set_precision (Precision)
 
void set_tolerance (double)
 
void set_refinement (unsigned)
 
void set_lis_option (std::string_view)
 
double get_ini_step_size () const
 
double get_min_step_size () const
 
double get_max_step_size () const
 
unsigned get_max_substep () const
 
bool is_fixed_step_size () const
 
void set_fixed_step_size (bool)
 
bool is_symm () const
 
bool is_band () const
 
bool is_sparse () const
 
void set_symm (bool) const
 
void set_band (bool) const
 
void set_sparse (bool) const
 
- Public Member Functions inherited from Tag
 Tag (unsigned=0)
 
 Tag (const Tag &)=default
 
 Tag (Tag &&)=default
 
Tag & operator= (const Tag &)=delete
 
Tag & operator= (Tag &&)=delete
 
virtual ~Tag ()=default
 
void set_tag (unsigned) const
 
unsigned get_tag () const
 
void enable ()
 
void disable ()
 
void guard ()
 
void unguard ()
 
bool is_active () const
 
bool is_guarded () const
 
virtual void print ()
 

Additional Inherited Members

- Protected Member Functions inherited from Step
void configure_storage_scheme () const
 
- Protected Attributes inherited from Step
const bool symm_mat = false
 
const bool band_mat = true
 
const bool sparse_mat = false
 
SolverType system_solver = SolverType::LAPACK
 
SolverSetting< double > system_setting {}
 
SolverType sub_system_solver = SolverType::LAPACK
 
weak_ptr< DomainBase > database
 
shared_ptr< Factory< double > > factory
 
shared_ptr< Solver > solver
 
shared_ptr< Converger > tester
 
shared_ptr< Integrator > modifier
 

Detailed Description

A Frequency class.

Author
tlc
Date
06/07/2018
Version
0.2.0

Constructor & Destructor Documentation

◆ Frequency()

Frequency::Frequency ( unsigned  T = 0,
unsigned  N = 4,
char  TP = 'S' 
)
explicit

Member Function Documentation

◆ analyze()

int Frequency::analyze ( )
overridevirtual

Implements Step.

Here is the call graph for this function:

◆ get_eigen_number()

unsigned Frequency::get_eigen_number ( ) const

◆ initialize()

int Frequency::initialize ( )
overridevirtual

Reimplemented from Step.

Here is the call graph for this function:

◆ set_eigen_number()

void Frequency::set_eigen_number ( unsigned  N) const
The documentation for this class was generated from the following files: