OpenFCST: The open-source Fuel Cell Simulation Toolbox
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SIM::ExperimentalData Class Reference

Description: Used to read in an array of experimental data with column headers. More...

#include <experimental_data.h>

Public Member Functions

 ExperimentalData (std::string filename)
 Constructor.
 
 ~ExperimentalData ()
 Destructor.
 
void parse_data_names () const
 Function that parses the data names and compares them against a list of acceptable parameters.
 
void print_data () const
 Function that prints the data header names and data values.
 
void extract_vector (std::string label, std::vector< double > &data_vector)
 Function to extract data from the experimental_values array into a vector.
 
void get_experimental_values (std::vector< std::string > &name_OC, std::vector< std::vector< double > > &value_OC) const
 function that gets the string vector and value array
 
int get_num_rows () const
 function that gets the string vector and value array
 
int get_num_columns () const
 function that returns the number of data points (rows) in the data file
 

Private Member Functions

void read_data_file ()
 Function that reads the input file and populates the data header names vector and data values array.
 

Private Attributes

std::vector< std::vector
< double > > 
experimental_values
 array of experimental values used in NLS parameter study
 
std::vector< std::string > data_names
 names of operating conditions for experimental values used in NLS parameter study
 
const std::string data_file
 String specifying the data file to be read.
 
std::vector< double > OCV_list
 vector of values holding the open circuit voltage for the data provided
 
std::vector< std::vector
< double > > 
OCV_conditions
 

Detailed Description

Description: Used to read in an array of experimental data with column headers.

For use with parameter estimation or generating polarization curves.Define the info you need

Constructor & Destructor Documentation

SIM::ExperimentalData::ExperimentalData ( std::string  filename)

Constructor.

SIM::ExperimentalData::~ExperimentalData ( )
inline

Destructor.

Member Function Documentation

void SIM::ExperimentalData::extract_vector ( std::string  label,
std::vector< double > &  data_vector 
)

Function to extract data from the experimental_values array into a vector.

Removes the extracted data from the array, and the name (label) from the data_names vector

void SIM::ExperimentalData::get_experimental_values ( std::vector< std::string > &  name_OC,
std::vector< std::vector< double > > &  value_OC 
) const

function that gets the string vector and value array

int SIM::ExperimentalData::get_num_columns ( ) const
inline

function that returns the number of data points (rows) in the data file

References experimental_values.

int SIM::ExperimentalData::get_num_rows ( ) const
inline

function that gets the string vector and value array

function that gets the string vector and value array function that returns the number of data points (rows) in the data file

References experimental_values.

void SIM::ExperimentalData::parse_data_names ( ) const

Function that parses the data names and compares them against a list of acceptable parameters.

void SIM::ExperimentalData::print_data ( ) const

Function that prints the data header names and data values.

void SIM::ExperimentalData::read_data_file ( )
private

Function that reads the input file and populates the data header names vector and data values array.

Member Data Documentation

const std::string SIM::ExperimentalData::data_file
private

String specifying the data file to be read.

std::vector<std::string> SIM::ExperimentalData::data_names
private

names of operating conditions for experimental values used in NLS parameter study

std::vector< std::vector<double> > SIM::ExperimentalData::experimental_values
private

array of experimental values used in NLS parameter study

Referenced by get_num_columns(), and get_num_rows().

std::vector<std::vector<double> > SIM::ExperimentalData::OCV_conditions
private
std::vector<double> SIM::ExperimentalData::OCV_list
private

vector of values holding the open circuit voltage for the data provided


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