Public Member Functions | List of all members
aspect::SolverControl Class Reference
Inheritance diagram for aspect::SolverControl:
Inheritance graph

Public Member Functions

 SolverControl (const unsigned int n=100, const double tol=1.e-10, const bool log_history=false, const bool log_result=true)
::SolverControl::State check (const unsigned int step, const double check_value)
const std::vector< double > & get_history_data () const
- Public Member Functions inherited from SolverControl
 SolverControl (const unsigned int n=100, const double tol=1.e-10, const bool log_history=false, const bool log_result=true)
virtual ~SolverControl () override=default
void parse_parameters (ParameterHandler &param)
State last_check () const
double initial_value () const
double last_value () const
unsigned int last_step () const
unsigned int max_steps () const
unsigned int set_max_steps (const unsigned int)
void set_failure_criterion (const double rel_failure_residual)
void clear_failure_criterion ()
double tolerance () const
double set_tolerance (const double)
void enable_history_data ()
const std::vector< double > & get_history_data () const
double average_reduction () const
double final_reduction () const
double step_reduction (unsigned int step) const
void log_history (const bool)
bool log_history () const
unsigned int log_frequency (unsigned int)
void log_result (const bool)
bool log_result () const
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 Subscriptor (const Subscriptor &)
 Subscriptor (Subscriptor &&) noexcept
virtual ~Subscriptor ()
Subscriptoroperator= (const Subscriptor &)
Subscriptoroperator= (Subscriptor &&) noexcept
std::enable_if< std::is_same< ConstCharStar, const char *>::value >::type subscribe (std::atomic< bool > *const validity, ConstCharStar identifier=nullptr) const
void subscribe (std::atomic< bool > *const validity, const char *&&identifier) const=delete
void unsubscribe (std::atomic< bool > *const validity, const char *identifier=nullptr) const
unsigned int n_subscriptions () const
void list_subscribers (StreamType &stream) const
void list_subscribers () const
void serialize (Archive &ar, const unsigned int version)

Additional Inherited Members

- Public Types inherited from SolverControl
enum  State
- Static Public Member Functions inherited from SolverControl
static void declare_parameters (ParameterHandler &param)
static ::ExceptionBaseExcHistoryDataRequired ()
- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
- Public Attributes inherited from SolverControl
- Protected Attributes inherited from SolverControl
unsigned int maxsteps
double tol
State lcheck
double initial_val
double lvalue
unsigned int lstep
bool check_failure
double relative_failure_residual
double failure_residual
bool m_log_history
unsigned int m_log_frequency
bool m_log_result
bool history_data_enabled
std::vector< double > history_data

Detailed Description

Definition at line 42 of file compat.h.

Constructor & Destructor Documentation

§ SolverControl()

aspect::SolverControl::SolverControl ( const unsigned int  n = 100,
const double  tol = 1.e-10,
const bool  log_history = false,
const bool  log_result = true 

Definition at line 45 of file compat.h.

Member Function Documentation

§ check()

::SolverControl::State aspect::SolverControl::check ( const unsigned int  step,
const double  check_value 

Reimplemented from SolverControl.

Definition at line 54 of file compat.h.

References SolverControl::check().

§ get_history_data()

const std::vector<double>& aspect::SolverControl::get_history_data ( ) const

Definition at line 66 of file compat.h.

References Assert, ExcHistoryDataRequired(), and ExcMessage().

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