Parameter Class Reference

Model Parameter. More...

#include <Parameter.h>

Public Member Functions
	Parameter (int id, double value)
	Construct a new Parameter object.
	Parameter (int id, const std::vector< double > &times, const std::vector< double > &values, bool periodic=true)
	Construct a new Parameter object.
void	update (double value)
	Update the parameter.
void	update (const std::vector< double > &times, const std::vector< double > &values)
	Update the parameter.
double	get (double time)
	Get the parameter value at the specified time.
void	to_steady ()
	Convert the parameter into a steady mean state.
void	to_unsteady ()
	Convert the parameter back into an unsteady mean state.

Public Attributes
int	id
	Global ID of the parameter.
std::vector< double >	times
	Time steps if parameter is time-dependent.
std::vector< double >	values
	Values if parameter is time-dependent.
double	value
	Value if parameter is constant.
double	cycle_period
int	size
	Size of the time series if parameter is time-dependent.
bool	is_constant
	Bool value indicating if the parameter is constant.
bool	is_periodic

Detailed Description

Model Parameter.

This class handles constant parameters and time-dependent parameters that need to be interpolated and periodically applied.

Constructor & Destructor Documentation

Parameter() [1/2]

Parameter::Parameter	(	int	id,
		double	value )

Construct a new Parameter object.

Parameters

id	Global ID of the parameter
value	The value of the parameter

Parameter() [2/2]

Parameter::Parameter	(	int	id,
		const std::vector< double > &	times,
		const std::vector< double > &	values,
		bool	periodic = true )

Construct a new Parameter object.

Parameters

id	Global ID of the parameter
times	Time steps corresponding to the time-dependent values
values	Values corresponding to the time steps
periodic	Is this parameter periodic with a cardiac cycle?

Member Function Documentation

get()

double Parameter::get

(

double

time

)

Get the parameter value at the specified time.

Parameters

time	Current time

Returns

Value at the time

to_steady()

void Parameter::to_steady

(

)

Convert the parameter into a steady mean state.

to_unsteady()

void Parameter::to_unsteady

(

)

Convert the parameter back into an unsteady mean state.

update() [1/2]

void Parameter::update	(	const std::vector< double > &	times,
		const std::vector< double > &	values )

Update the parameter.

Parameters

times	Time steps corresponding to the values
values	Values correspondong to the time steps

update() [2/2]

void Parameter::update

(

double

value

)

Update the parameter.

Parameters

value

Value of the parameter

Member Data Documentation

cycle_period

double Parameter::cycle_period

Cardiac cycle period corresponding to the time sequence

id

int Parameter::id

Global ID of the parameter.

is_constant

bool Parameter::is_constant

Bool value indicating if the parameter is constant.

is_periodic

bool Parameter::is_periodic

Bool value indicating if the parameter is periodic with the cardiac cycle

size

int Parameter::size

Size of the time series if parameter is time-dependent.

times

std::vector<double> Parameter::times

Time steps if parameter is time-dependent.

value

double Parameter::value

Value if parameter is constant.

values

std::vector<double> Parameter::values

Values if parameter is time-dependent.

---

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

• model/Parameter.h
• model/Parameter.cpp