simlib3::AlgLoop Class Reference

abstract base for algebraic loop solvers More...

#include <simlib.h>

Inheritance diagram for simlib3::AlgLoop:

Collaboration diagram for simlib3::AlgLoop:

Public Member Functions
	AlgLoop (Input i, double eps, unsigned long max_it, double t_min, double t_max, double t0)
void	Set (double eps, unsigned long max_it, double t_min, double t_max, double t0)
void	Set (double eps, unsigned long max_it, double t_min, double t_max)
Public Member Functions inherited from simlib3::aContiBlock1
	aContiBlock1 (Input i)
	constructor for blocks with single input More...
double	InputValue ()
Public Member Functions inherited from simlib3::aContiBlock
	aContiBlock ()
virtual void	_Eval ()
	evaluate block (with loop detection) More...
virtual double	Value ()=0
	get block output value this method should be defined in classes derived from aContiBlock More...
Public Member Functions inherited from simlib3::SimObject
bool	TestAndSetFlag (bool new_value, unsigned n)
	internal method for flag manipulation is used for algebraic loop checking in continuous blocks More...
	SimObject ()
	constructor More...
virtual	~SimObject ()
	virtual destructor More...
void *	operator new (size_t size)
	allocate object, set _flags More...
void	operator delete (void *ptr)
	deallocate object More...
void *	operator new[] (size_t size)=delete
void	operator delete[] (void *ptr)=delete
bool	isAllocated () const
virtual std::string	Name () const
	get object name More...
bool	HasName () const
void	SetName (const std::string &name)
	assign the name More...
virtual void	Output () const
	print object to default output More...

Protected Attributes
double	Eps
unsigned long	MaxIt
double	TA
double	TB
double	T0
bool	was_cycle
int	phase
double	root
Protected Attributes inherited from simlib3::aContiBlock
bool	isEvaluated
Protected Attributes inherited from simlib3::SimObject
unsigned	_flags
	bool flags for internal use (TODO bitfield?) More...

Additional Inherited Members
Public Types inherited from simlib3::SimObject
enum	_Flags { _CLEAR_ALL_FLAGS = 0, _ALLOCATED_FLAG = 1<<0, _EVAL_FLAG = 1<<1, _HAS_NAME_FLAG = 1<<2 }

Detailed Description

abstract base for algebraic loop solvers

Definition at line 1646 of file simlib.h.

Constructor & Destructor Documentation

AlgLoop()

simlib3::AlgLoop::AlgLoop	(	Input	i,
		double	eps,
		unsigned long	max_it,
		double	t_min,
		double	t_max,
		double	t0
	)

Definition at line 39 of file algloop.cc.

References simlib3::AL_BadBounds, simlib3::AL_BadInitVal, and simlib3::SIMLIB_error().

Member Function Documentation

Set() [1/2]

void simlib3::AlgLoop::Set	(	double	eps,
		unsigned long	max_it,
		double	t_min,
		double	t_max,
		double	t0
	)

Definition at line 63 of file algloop.cc.

References simlib3::AL_BadBounds, simlib3::AL_BadInitVal, Eps, MaxIt, simlib3::SIMLIB_error(), T0, TA, and TB.

Set() [2/2]

void simlib3::AlgLoop::Set	(	double	eps,
		unsigned long	max_it,
		double	t_min,
		double	t_max
	)

Definition at line 83 of file algloop.cc.

References simlib3::AL_BadBounds, Eps, simlib3::SimObject::HasName(), MaxIt, simlib3::SimObject::Name(), simlib3::SIMLIB_create_tmp_name(), simlib3::SIMLIB_error(), T0, TA, and TB.

Member Data Documentation

Eps

double simlib3::AlgLoop::Eps

protected

Definition at line 1648 of file simlib.h.

Referenced by Set(), simlib3::Iterations::Value(), simlib3::Bisect::Value(), simlib3::RegulaFalsi::Value(), and simlib3::Newton::Value().

MaxIt

unsigned long simlib3::AlgLoop::MaxIt

protected

Definition at line 1649 of file simlib.h.

Referenced by Set(), simlib3::Iterations::Value(), simlib3::Bisect::Value(), simlib3::RegulaFalsi::Value(), and simlib3::Newton::Value().

phase

int simlib3::AlgLoop::phase

protected

Definition at line 1654 of file simlib.h.

Referenced by simlib3::Iterations::Value(), simlib3::Bisect::Value(), simlib3::RegulaFalsi::Value(), and simlib3::Newton::Value().

root

double simlib3::AlgLoop::root

protected

Definition at line 1655 of file simlib.h.

Referenced by simlib3::Iterations::Value(), simlib3::Bisect::Value(), simlib3::RegulaFalsi::Value(), and simlib3::Newton::Value().

T0

double simlib3::AlgLoop::T0

protected

Definition at line 1652 of file simlib.h.

Referenced by Set(), simlib3::Iterations::Value(), and simlib3::Newton::Value().

TA

double simlib3::AlgLoop::TA

protected

Definition at line 1650 of file simlib.h.

Referenced by Set(), simlib3::Bisect::Value(), simlib3::RegulaFalsi::Value(), and simlib3::Newton::Value().

TB

double simlib3::AlgLoop::TB

protected

Definition at line 1651 of file simlib.h.

Referenced by Set(), simlib3::Iterations::Value(), simlib3::Bisect::Value(), simlib3::RegulaFalsi::Value(), and simlib3::Newton::Value().

was_cycle

bool simlib3::AlgLoop::was_cycle

protected

Definition at line 1653 of file simlib.h.

Referenced by simlib3::Iterations::Value(), simlib3::Bisect::Value(), simlib3::RegulaFalsi::Value(), and simlib3::Newton::Value().

---

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

• src/simlib.h
• src/algloop.cc