State Class Reference

State of the system. More...

#include <State.h>

Public Member Functions
	State ()
	Construct a new State object.
	State (int n)
	Construct a new State object.
	~State ()
	Destroy the State object.
	State (const State &state)
	Copy a State object.

Static Public Member Functions
static State	Zero (int n)
	Construct a new State object and initilaize with all zeros.

Public Attributes
Eigen::Matrix< double, Eigen::Dynamic, 1 >	y
	Vector of solution quantities.
Eigen::Matrix< double, Eigen::Dynamic, 1 >	ydot
	Derivate of y.

Detailed Description

State of the system.

Stores the current state of a system, i.e. the current value and derivate of all variables.

Constructor & Destructor Documentation

State() [1/3]

State::State

(

)

Construct a new State object.

State() [2/3]

State::State

(

int

n

)

Construct a new State object.

Parameters

n	Size of the state

~State()

State::~State

(

)

Destroy the State object.

State() [3/3]

State::State

(

const State &

state

)

Copy a State object.

Parameters

state

Member Function Documentation

Zero()

State State::Zero ( int n )

static

Construct a new State object and initilaize with all zeros.

Parameters

n	Size of the state

Returns

New state initialized with all zeros

Member Data Documentation

y

Eigen::Matrix<double, Eigen::Dynamic, 1> State::y

Vector of solution quantities.

ydot

Eigen::Matrix<double, Eigen::Dynamic, 1> State::ydot

Derivate of y.

---

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

• algebra/State.h
• algebra/State.cpp