Code-Eli  0.3.6
eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ > Class Template Reference

#include <newton_raphson_constrained_system_method.hpp>

Inheritance diagram for eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >:
Collaboration diagram for eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >:

Public Types

enum  end_condition_usage { NRC_NOT_USED = -1, NRC_EXCLUSIVE = 0, NRC_INCLUSIVE = 1, NRC_PERIODIC = 2 }
 
typedef data__ data_type
 
- Public Types inherited from eli::mutil::nls::iterative_system_root_base< data__, N__, NSOL__ >
enum  system_norm_type {
  L1 =100, L2 =200, Linf =300, max_norm =400,
  Frobenius_norm =500
}
 
typedef Eigen::Matrix< data__, N__, NSOL__ > solution_matrix
 
typedef Eigen::Matrix< data__, N__, N__ > jacobian_matrix
 
- Public Types inherited from eli::mutil::nls::iterative_root_base< data__ >
typedef convergence_tester< data__ > error_tolerance_type
 
typedef convergence_tester< size_t > max_iteration_type
 
typedef error_tolerance_type::data_type tolerance_type
 
typedef max_iteration_type::data_type iteration_type
 

Public Member Functions

 newton_raphson_constrained_system_method ()
 
 newton_raphson_constrained_system_method (const newton_raphson_constrained_system_method< data_type, N__, NSOL__ > &nrm)
 
 ~newton_raphson_constrained_system_method ()
 
void unset_conditions ()
 
void set_periodic_condition (size_t i, const data_type &dmin, const data_type &dmax)
 
void unset_lower_condition ()
 
void unset_lower_condition (size_t i)
 
void set_lower_condition (size_t i, const data_type &d, end_condition_usage ec)
 
void get_lower_condition (data_type &d, end_condition_usage &ec, size_t i)
 
void unset_upper_condition ()
 
void unset_upper_condition (size_t i)
 
void set_upper_condition (size_t i, const data_type &d, end_condition_usage ec)
 
void get_upper_condition (data_type &d, end_condition_usage &ec, size_t i)
 
- Public Member Functions inherited from eli::mutil::nls::newton_raphson_system_method< data__, N__, NSOL__ >
 newton_raphson_system_method ()
 
 newton_raphson_system_method (const newton_raphson_system_method< data__, N__, NSOL__ > &nrm)
 
 ~newton_raphson_system_method ()
 
void set_initial_guess (const typename iterative_system_root_base< data__, N__, NSOL__ >::solution_matrix &xg)
 
const iterative_system_root_base< data__, N__, NSOL__ >::solution_matrixget_initial_guess () const
 
template<typename f__ , typename g__ >
int find_root (typename iterative_system_root_base< data__, N__, NSOL__ >::solution_matrix &root, const f__ &fun, const g__ &fprime, const typename iterative_system_root_base< data__, N__, NSOL__ >::solution_matrix &f0) const
 
- Public Member Functions inherited from eli::mutil::nls::iterative_system_root_base< data__, N__, NSOL__ >
 iterative_system_root_base ()
 
 iterative_system_root_base (const iterative_system_root_base< data__, N__, NSOL__ > &isrb)
 
 ~iterative_system_root_base ()
 
system_norm_type get_norm_type () const
 
void set_norm_type (system_norm_type snt)
 
- Public Member Functions inherited from eli::mutil::nls::iterative_root_base< data__ >
 iterative_root_base ()
 
 iterative_root_base (const iterative_root_base< data__ > &irb)
 
virtual ~iterative_root_base ()
 
void set_relative_tolerance (const tolerance_type &rel_tol)
 
tolerance_type get_relative_tolerance () const
 
void set_absolute_tolerance (const tolerance_type &abs_tol)
 
tolerance_type get_absolute_tolerance () const
 
void set_max_iteration (const iteration_type &mi)
 
iteration_type get_max_iteration () const
 
void enforce_both_tolerance (bool ebt)
 
bool enforce_both_tolerance () const
 
void disable_relative_tolerance ()
 
void disable_absolute_tolerance ()
 
const error_tolerance_typeget_tolerance_tester () const
 
const max_iteration_typeget_iteration_count_tester () const
 
const iteration_typeget_iteration_count () const
 

Private Member Functions

virtual iterative_system_root_base< data_type, N__, NSOL__ >::solution_matrix calculate_delta_factor (const typename iterative_system_root_base< data_type, N__, NSOL__ >::solution_matrix &x, const typename iterative_system_root_base< data_type, N__, NSOL__ >::solution_matrix &dx) const
 

Private Attributes

data_type xmin [N__]
 
data_type xmax [N__]
 
end_condition_usage xmin_cond [N__]
 
end_condition_usage xmax_cond [N__]
 

Additional Inherited Members

- Static Public Attributes inherited from eli::mutil::nls::newton_raphson_system_method< data__, N__, NSOL__ >
static const int hit_constraint = 101
 
- Static Public Attributes inherited from eli::mutil::nls::iterative_root_base< data__ >
static const int converged = 0
 
static const int max_iteration = 1
 
static const int no_root_found = 2
 
- Protected Member Functions inherited from eli::mutil::nls::iterative_system_root_base< data__, N__, NSOL__ >
data__ calculate_norm (const solution_matrix &mat) const
 
- Protected Member Functions inherited from eli::mutil::nls::iterative_root_base< data__ >
bool test_converged (const iteration_type &it, const tolerance_type &relv, const tolerance_type &absv) const
 
bool max_iteration_reached (const iteration_type &it) const
 

Member Typedef Documentation

template<typename data__, size_t N__, size_t NSOL__ = 1>
typedef data__ eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::data_type

Member Enumeration Documentation

template<typename data__, size_t N__, size_t NSOL__ = 1>
enum eli::mutil::nls::newton_raphson_constrained_system_method::end_condition_usage
Enumerator
NRC_NOT_USED 
NRC_EXCLUSIVE 
NRC_INCLUSIVE 
NRC_PERIODIC 

Constructor & Destructor Documentation

template<typename data__, size_t N__, size_t NSOL__ = 1>
eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::newton_raphson_constrained_system_method ( )
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::newton_raphson_constrained_system_method ( const newton_raphson_constrained_system_method< data_type, N__, NSOL__ > &  nrm)
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::~newton_raphson_constrained_system_method ( )
inline

Member Function Documentation

template<typename data__, size_t N__, size_t NSOL__ = 1>
virtual iterative_system_root_base<data_type, N__, NSOL__>::solution_matrix eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::calculate_delta_factor ( const typename iterative_system_root_base< data_type, N__, NSOL__ >::solution_matrix x,
const typename iterative_system_root_base< data_type, N__, NSOL__ >::solution_matrix dx 
) const
inlineprivatevirtual
template<typename data__, size_t N__, size_t NSOL__ = 1>
void eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::get_lower_condition ( data_type d,
end_condition_usage ec,
size_t  i 
)
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
void eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::get_upper_condition ( data_type d,
end_condition_usage ec,
size_t  i 
)
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
void eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::set_lower_condition ( size_t  i,
const data_type d,
end_condition_usage  ec 
)
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
void eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::set_periodic_condition ( size_t  i,
const data_type dmin,
const data_type dmax 
)
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
void eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::set_upper_condition ( size_t  i,
const data_type d,
end_condition_usage  ec 
)
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
void eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::unset_conditions ( )
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
void eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::unset_lower_condition ( )
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
void eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::unset_lower_condition ( size_t  i)
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
void eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::unset_upper_condition ( )
inline
template<typename data__, size_t N__, size_t NSOL__ = 1>
void eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::unset_upper_condition ( size_t  i)
inline

Member Data Documentation

template<typename data__, size_t N__, size_t NSOL__ = 1>
data_type eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::xmax[N__]
private
template<typename data__, size_t N__, size_t NSOL__ = 1>
end_condition_usage eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::xmax_cond[N__]
private
template<typename data__, size_t N__, size_t NSOL__ = 1>
data_type eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::xmin[N__]
private
template<typename data__, size_t N__, size_t NSOL__ = 1>
end_condition_usage eli::mutil::nls::newton_raphson_constrained_system_method< data__, N__, NSOL__ >::xmin_cond[N__]
private

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