OpenFCST: The open-source Fuel Cell Simulation Toolbox
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Attributes | List of all members
FuelCellShop::Equation::VariableInfo Struct Reference

This simple structure stores certain information regarding a particular variable for the equation (all of them retrieved from #SystemManagement). More...

#include <equation_base.h>

Public Attributes

unsigned int solution_index
 Index of the user-defined solution variable, retrieved from #SystemManagement.
 
unsigned int block_index
 Block index of the matrix relating to the variable corresponding to an equation, retrieved from #SystemManagement.
 
unsigned int fetype_index
 Index corresponding to type of fevalue object used for this variable.
 
bool indices_exist
 Boolean storing whether indices exist or not.
 

Detailed Description

This simple structure stores certain information regarding a particular variable for the equation (all of them retrieved from #SystemManagement).

The purpose of defining such a structure is to avoid repeated use of #SystemManagement functions, (which use find methods), hence improving code speed.

This structure will normally be filled in #make_assemblers_generic_constant_data of derived classes.

Author
Madhur Bhaiya, 2013

Member Data Documentation

unsigned int FuelCellShop::Equation::VariableInfo::block_index

Block index of the matrix relating to the variable corresponding to an equation, retrieved from #SystemManagement.

unsigned int FuelCellShop::Equation::VariableInfo::fetype_index

Index corresponding to type of fevalue object used for this variable.

This information is also retrieved from #SystemManagement, from a group of actual FEVALUES objects (in AppFrame).

bool FuelCellShop::Equation::VariableInfo::indices_exist

Boolean storing whether indices exist or not.

This boolean member is very useful for checks inside the derived equation classes, to avoid errors.

unsigned int FuelCellShop::Equation::VariableInfo::solution_index

Index of the user-defined solution variable, retrieved from #SystemManagement.


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