Holds expressions and meta-data corresponding to a physical quantity evolving in time. More...

#include <dae_builder_internal.hpp>

Detailed Description

Date: 2012-2021

Author: Joel Andersson

Extra doc: https://github.com/casadi/casadi/wiki/L_t

Definition at line 81 of file dae_builder_internal.hpp.

Collaboration diagram for casadi::Variable:

[legend]

Public Member Functions
casadi_int	size (Attribute a) const
	Total number of elements for a particular attribute. More...

XmlNode	export_xml (const DaeBuilderInternal &self) const

bool	is_real () const

bool	has_start () const

bool	has_der () const

std::vector< Category >	categories () const

bool	permitted (Category cat) const

bool	is_set () const

bool	has_beq () const

bool	needs_der () const

MX	get_der (DaeBuilderInternal &self, bool may_allocate=true)

MX	get_der (const DaeBuilderInternal &self) const


void	get_attribute (Attribute a, double *val) const

void	get_attribute (Attribute a, std::vector< double > *val) const

void	get_attribute (Attribute a, std::string *val) const


void	set_attribute (Attribute a, double val)

void	set_attribute (Attribute a, const std::vector< double > &val)

void	set_attribute (Attribute a, const std::string &val)

Public Attributes
casadi_int	index
	Location in variable vector. More...

std::string	name
	Name of the variable. More...

std::vector< casadi_int >	dimension
	Dimensions. More...

casadi_int	numel
	Number of elements - product of all dimensions. More...

Category	category
	CasADi's classification of the variable. More...

casadi_int	der

casadi_int	bind

bool	in_rhs

std::vector< double >	value
	Numerical value (also for booleans, integers, enums) More...

std::string	stringvalue
	String value (if string-valued) More...

bool	dependency
	Do other expressions depend on this variable. More...

std::vector< casadi_int >	dependencies
	Dependencies. More...

std::vector< DependenciesKind >	dependenciesKind
	Dependencies. More...

MX	v
	Variable expression (always a vector) More...

MX	ieq
	Initial equation (to be removed and moved to a separate dependent variable) More...


unsigned int	value_reference

std::string	description

Type	type

Causality	causality

Variability	variability


std::string	unit

std::string	display_unit

Initial	initial

double	min

double	max

double	nominal

std::vector< double >	start

casadi_int	der_of

casadi_int	parent

Friends
class	DaeBuilderInternal

Member Function Documentation

◆ categories()

std::vector< Category > casadi::Variable::categories ( ) const

Definition at line 561 of file dae_builder_internal.cpp.

                                                {
   switch (category) {
     case Category::T:
       if (in_rhs) {
         return {Category::T};
       } else {
         return {Category::T, Category::NUMEL};
       }
     case Category::P:  // Fall-through
     case Category::U:  // Fall-through
     case Category::C:
       return {Category::P, Category::U, Category::C};
     case Category::X:  // Fall-through
     case Category::Q:
       if (in_rhs) {
         return {Category::X};
       } else {
         return {Category::X, Category::Q, Category::NUMEL};
       }
     case Category::NUMEL:
       if (causality == Causality::INDEPENDENT) {
         return {Category::T, Category::NUMEL};
       } else if (has_der()) {
         return {Category::Q, Category::NUMEL};
       } else {
         return {Category::NUMEL};
       }
     case Category::D: return {Category::D};
     case Category::W: return {Category::W};
     case Category::CALCULATED: return {Category::CALCULATED};
     case Category::Z: return {Category::Z};
     default: break;
   }
   // Error
   casadi_error("Cannot handle category: " + to_string(category));
   return {};
 }

References casadi::C, casadi::CALCULATED, category, causality, casadi::D, has_der(), in_rhs, casadi::INDEPENDENT, casadi::NUMEL, casadi::P, casadi::Q, casadi::T, casadi::to_string(), casadi::U, casadi::W, casadi::X, and casadi::Z.

Referenced by permitted().

◆ export_xml()

XmlNode casadi::Variable::export_xml ( const DaeBuilderInternal & self ) const

Definition at line 470 of file dae_builder_internal.cpp.

                                                                  {
   // Create new XmlNode
   XmlNode r;
   r.name = to_string(type);
   // Name of variable
   r.set_attribute("name", name);
   // Value reference
   r.set_attribute("valueReference", static_cast<casadi_int>(value_reference));
   // Description, if any
   if (!description.empty()) r.set_attribute("description", description);
   // Causality
   if (causality != Causality::LOCAL)
     r.set_attribute("causality", to_string(causality));
   // Variability (real variables are continuous by default)
   if (!(is_real() && variability == Variability::CONTINUOUS))
     r.set_attribute("variability", to_string(variability));
   // Initial property
   if (initial != Initial::NA && initial != Initial::NUMEL) {
     r.set_attribute("initial", to_string(initial));
   }
   // Minimum attribute
   if (min != -inf) {
     if (is_real()) {
       r.set_attribute("min", min);
     } else {
       r.set_attribute("min", static_cast<casadi_int>(min));
     }
   }
   // Maximum attribute
   if (max != inf) {
     if (is_real()) {
       r.set_attribute("max", max);
     } else {
       r.set_attribute("max", static_cast<casadi_int>(max));
     }
   }
   // Unit
   if (!unit.empty()) r.set_attribute("unit", unit);
   // Display unit
   if (!display_unit.empty()) r.set_attribute("displayUnit", display_unit);
   // Nominal value, only for floats
   if (is_real() && nominal != 1.) r.set_attribute("nominal", nominal);
   // Start attribute, if any
   if (has_start()) {
     if (type == Type::BINARY || type == Type::STRING) {
       casadi_warning("Start attribute for String, Binary not implemented.");
     } else {
       // Convert to string
       std::stringstream ss;
       for (size_t i = 0; i < start.size(); ++i) {
         if (i > 0) ss << " ";
         if (is_real()) {
           ss << start.at(i);
         } else {
           ss << static_cast<casadi_int>(start.at(i));
         }
       }
       r.set_attribute("start", ss.str());
     }
   }
   // Derivative attribute, if any
   if (der_of >= 0) {
       r.set_attribute("derivative",
         static_cast<casadi_int>(self.variable(der_of).value_reference));
   }
   // Return XML representation
   return r;
 }

References casadi::BINARY, causality, casadi::CONTINUOUS, der_of, description, display_unit, has_start(), casadi::inf, initial, is_real(), casadi::LOCAL, max, min, casadi::NA, name, casadi::XmlNode::name, nominal, casadi::NUMEL, casadi::XmlNode::set_attribute(), start, casadi::STRING, casadi::to_string(), type, unit, value_reference, and variability.

◆ get_attribute() [1/3]

void casadi::Variable::get_attribute	(	Attribute	a,
		double *	val
	)		const

Get by attribute name

Definition at line 322 of file dae_builder_internal.cpp.

                                                            {
   // Only if scalar
   casadi_assert(numel == 1, "Variable " + name + " is not scalar");
   // Handle attributes
   switch (a) {
     case Attribute::MIN:
       if (val) *val = min;
       return;
     case Attribute::MAX:
       if (val) *val = max;
       return;
     case Attribute::NOMINAL:
       if (val) *val = nominal;
       return;
     case Attribute::START:
       if (val) *val = start.front();
       return;
     case Attribute::VALUE:
       if (val) *val = value.front();
       return;
     default:
       break;
   }
   casadi_error("Cannot handle: " + to_string(a));
 }

References casadi::MAX, max, casadi::MIN, min, name, casadi::NOMINAL, nominal, numel, casadi::START, start, casadi::to_string(), casadi::VALUE, and value.

Referenced by casadi::DaeBuilderInternal::attribute(), casadi::DaeBuilder::get(), get_attribute(), and casadi::DaeBuilderInternal::string_attribute().

◆ get_attribute() [2/3]

void casadi::Variable::get_attribute	(	Attribute	a,
		std::string *	val
	)		const

Get by attribute name

Definition at line 370 of file dae_builder_internal.cpp.

                                                               {
   switch (a) {
     case Attribute::STRINGVALUE:
       if (val) *val = stringvalue;
       return;
     default:
       break;
   }
   casadi_error("Cannot handle: " + to_string(a));
 }

References casadi::STRINGVALUE, stringvalue, and casadi::to_string().

◆ get_attribute() [3/3]

void casadi::Variable::get_attribute	(	Attribute	a,
		std::vector< double > *	val
	)		const

Get by attribute name

Definition at line 348 of file dae_builder_internal.cpp.

                                                                       {
   // Resize return
   if (val) val->resize(size(a));
   // Quick return if scalar
   if (size(a) == 1) {
     get_attribute(a, val ? &val->front() : nullptr);
     return;
   }
   // Handle vector attributes
   switch (a) {
     case Attribute::START:
       if (val) std::copy(start.begin(), start.end(), val->begin());
       return;
     case Attribute::VALUE:
       if (val) std::copy(value.begin(), value.end(), val->begin());
       return;
     default:
       break;
   }
   casadi_error("Cannot handle: " + to_string(a));
 }

References get_attribute(), size(), casadi::START, start, casadi::to_string(), casadi::VALUE, and value.

◆ get_der() [1/2]

MX casadi::Variable::get_der ( const DaeBuilderInternal & self ) const

Definition at line 606 of file dae_builder_internal.cpp.

                                                          {
   if (causality == Causality::INDEPENDENT) {
     // Time derivative of independent variable is 1
     return 1;
   } else if (needs_der()) {
     casadi_assert(der >= 0, "Variable " + name + " has no time derivative");
     // Should have a derviative expression
     return self.variable(der).v;
   } else {
     // Constant or piecewise constant variable
     return MX::zeros(v.sparsity());
   }
 }

References causality, der, casadi::INDEPENDENT, name, needs_der(), casadi::MX::sparsity(), v, and casadi::GenericMatrix< MX >::zeros().

◆ get_der() [2/2]

MX casadi::Variable::get_der	(	DaeBuilderInternal &	self,
		bool	may_allocate = `true`
	)

Definition at line 620 of file dae_builder_internal.cpp.

                                                                 {
   // Create a new derivative variable, if needed
   if (may_allocate && needs_der() && der < 0) {
     Variable& der_v = self.new_variable("der(" + name + ")", dimension);
     self.categorize(der_v.index, Category::Z);
     der_v.der_of = index;
     der_v.parent = index;
     der = der_v.index;
     // Add to list of derivatives
     self.der_.push_back(der_v.index);
   }
   // Call the const overload
   return get_der(const_cast<const DaeBuilderInternal&>(self));
 }

References der, der_of, dimension, index, name, needs_der(), parent, and casadi::Z.

◆ has_beq()

bool casadi::Variable::has_beq ( ) const

inline

Definition at line 204 of file dae_builder_internal.hpp.

204 {return bind >= 0;}

casadi::Variable::bind

casadi_int bind

Definition: dae_builder_internal.hpp:135

◆ has_der()

bool casadi::Variable::has_der ( ) const

inline

Definition at line 188 of file dae_builder_internal.hpp.

                        {
     return der != size_t(-1) || causality == Causality::INDEPENDENT;
   }

References casadi::INDEPENDENT.

Referenced by categories(), and casadi::DaeBuilderInternal::set_category().

◆ has_start()

bool casadi::Variable::has_start ( ) const

Definition at line 540 of file dae_builder_internal.cpp.

                                {
   // Rules, according to the FMI 3.0 specification, Section 2.4.7.5.
   if (initial == Initial::EXACT || initial == Initial::APPROX) return true;
   if (initial == Initial::CALCULATED || causality == Causality::INDEPENDENT) return false;
   if (causality == Causality::PARAMETER) return true;
   if (causality == Causality::INPUT) return true;
   if (variability == Variability::CONSTANT) return true;
   return false;
 }

References casadi::APPROX, casadi::CALCULATED, causality, casadi::CONSTANT, casadi::EXACT, casadi::INDEPENDENT, initial, casadi::INPUT, casadi::PARAMETER, and variability.

Referenced by export_xml().

◆ is_real()

bool casadi::Variable::is_real ( ) const

inline

Definition at line 182 of file dae_builder_internal.hpp.

182 {return type == Type::FLOAT32 || type == Type::FLOAT64;}

casadi::Type::FLOAT64

@ FLOAT64

casadi::Type::FLOAT32

@ FLOAT32

References casadi::FLOAT32, and casadi::FLOAT64.

Referenced by export_xml().

◆ is_set()

bool casadi::Variable::is_set ( ) const

inline

Definition at line 199 of file dae_builder_internal.hpp.

                       {
     return !(type==Type::STRING ? stringvalue.empty() : std::isnan(value.front()));
   }

References casadi::STRING.

Referenced by casadi::Fmu2::init(), and casadi::Fmu3::init().

◆ needs_der()

bool casadi::Variable::needs_der ( ) const

Definition at line 550 of file dae_builder_internal.cpp.

                                {
   // Only continuous variables can have derivatives
   if (variability != Variability::CONTINUOUS) return false;
   // Independent variables have trivial derivatives (1)
   if (causality == Causality::INDEPENDENT) return false;
   // Inputs are assumed piecewise constant
   if (causality == Causality::INPUT) return false;
   // Other variables may have derivatives
   return true;
 }

References causality, casadi::CONTINUOUS, casadi::INDEPENDENT, casadi::INPUT, and variability.

Referenced by get_der().

◆ permitted()

bool casadi::Variable::permitted ( Category cat ) const

Definition at line 599 of file dae_builder_internal.cpp.

                                            {
   for (auto c : categories()) {
     if (c == cat) return true;
   }
   return false;
 }

References categories().

◆ set_attribute() [1/3]

void casadi::Variable::set_attribute	(	Attribute	a,
		const std::string &	val
	)

Set by attribute name

Definition at line 429 of file dae_builder_internal.cpp.

                                                               {
   switch (a) {
     case Attribute::STRINGVALUE:
       stringvalue = val;
       return;
     default:
       break;
   }
 }

References casadi::STRINGVALUE, and stringvalue.

◆ set_attribute() [2/3]

void casadi::Variable::set_attribute	(	Attribute	a,
		const std::vector< double > &	val
	)

Set by attribute name

Definition at line 405 of file dae_builder_internal.cpp.

                                                                       {
   // Quick return if scalar
   if (val.size() == 1) {
     set_attribute(a, val.front());
     return;
   }
   // If not scalar, size must be number of elements
   casadi_assert(val.size() == numel, "Wrong size for attribute " + to_string(a));
   // Handle vector attributes
   switch (a) {
     case Attribute::START:
       std::copy(val.begin(), val.end(), start.begin());
       return;
     case Attribute::VALUE:
       std::copy(val.begin(), val.end(), value.begin());
       return;
     default:
       break;
   }
   casadi_error("Cannot handle: " + to_string(a));
 }

References numel, set_attribute(), casadi::START, start, casadi::to_string(), casadi::VALUE, and value.

◆ set_attribute() [3/3]

void casadi::Variable::set_attribute	(	Attribute	a,
		double	val
	)

Set by attribute name

Definition at line 381 of file dae_builder_internal.cpp.

                                                     {
   // Handle attributes
   switch (a) {
     case Attribute::MIN:
       min = val;
       return;
     case Attribute::MAX:
       max = val;
       return;
     case Attribute::NOMINAL:
       nominal = val;
       return;
     case Attribute::START:
       std::fill(start.begin(), start.end(), val);
       return;
     case Attribute::VALUE:
       std::fill(value.begin(), value.end(), val);
       return;
     default:
       break;
   }
   casadi_error("Cannot handle: " + to_string(a));
 }

References casadi::MAX, max, casadi::MIN, min, casadi::NOMINAL, nominal, casadi::START, start, casadi::to_string(), casadi::VALUE, and value.

Referenced by casadi::DaeBuilderInternal::add(), casadi::DaeBuilderInternal::set_attribute(), set_attribute(), and casadi::DaeBuilderInternal::set_string_attribute().

◆ size()

casadi_int casadi::Variable::size ( Attribute a ) const

Definition at line 310 of file dae_builder_internal.cpp.

                                            {
   switch (a) {
     case Attribute::START:  // Fall-through
     case Attribute::VALUE:
       // Vector-valued attribute
       return numel;
     default:
       break;
   }
   return 1;
 }