fcst_variables.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
//
// FCST: Fuel Cell Simulation Toolbox
//
// Copyright (C) 2006-2013 by Energy Systems Design Laboratory, University of Alberta
//
// This software is distributed under the MIT License
// For more information, see the README file in /doc/LICENSE
//
// - Class: fcst_variables.h
// - Description: Header file storing list of fcst variables and solution variable structures etc.
// - Developers: Phil Wardlaw,    University of Alberta
//               Madhur Bhaiya,   University of Alberta
// - $Id: base_layer.h 1267 2013-08-07 17:22:53Z madhur $
//
// ----------------------------------------------------------------------------

#ifndef _FUELCELLSHOP_VARIABLES_H
#define _FUELCELLSHOP_VARIABLES_H

// Include deal.II classes
#include <base/parameter_handler.h>
#include <base/point.h>
#include <base/function.h>
#include <lac/vector.h>
#include <fe/fe_values.h>

//Include STL
#include <cmath>
#include <iostream>

// Include OpenFCST routines:
#include "utils/system_management.h"

using namespace dealii;

namespace FuelCellShop
{    
    struct SolutionVariable
    {

        
        SolutionVariable()
        {
            data = NULL;
            initialized = false;
        }
        
        SolutionVariable(const std::vector<double>* data_in, const VariableNames& name_in)
        {
            data = data_in;
            name = name_in;
            initialized = true;
        }
        
        SolutionVariable(const double& value, const unsigned int& length, const VariableNames& name_in)
        {
            data = NULL;
            default_data = std::vector<double>(length, value);
            name = name_in;
            initialized = true;
        }

        SolutionVariable(const std::vector<double>& data_in, const VariableNames& name_in)
        {
            data = NULL;
            default_data = data_in;
            name = name_in;
            initialized = true;
        }

        


        const double& operator[](const unsigned int& i) const
        {
            Assert( initialized, ExcMessage("SolutionVariables struct is not initialized !!!") );
            
            if (data != NULL)
            {
                Assert( i < data->size(), ExcMessage("Index is out of range in operator[] for SolutionVariables struct.") );
                return data->at(i);
            }
            else if (data == NULL)
            {
                Assert( i < default_data.size(), ExcMessage("Index is out of range in operator[] for SolutionVariables struct.") );
                return default_data.at(i);
            }
        }

        bool is_initialized() const
        {
            return initialized;
        }
          
        unsigned int size() const
        {
            unsigned int answer = 0;
            //If initialized and pointer is not NULL
            if (initialized && (data != NULL))
                answer = data->size();
            else if (initialized && (data == NULL))
                answer = default_data.size();
            
            return answer;
        }

        VariableNames get_variablename() const
        {
            Assert( initialized, ExcMessage("SolutionVariable not initialized !!!") );
            return name;
        }
        
        
    private:
        std::vector<double>           default_data;
        
        const std::vector<double>*    data;
        
        VariableNames                  name;
        
        bool                          initialized;
    };


    
    static bool is_phiM(const SolutionVariable& sol_var)
    {
        return (sol_var.get_variablename() == protonic_electrical_potential);
    }
    
    static bool is_phiS(const SolutionVariable& sol_var)
    {
        return (sol_var.get_variablename() == electronic_electrical_potential);
    }
    

    
}  // FuelCellShop
    
#endif // _FUELCELLSHOP_VARIABLES_H