AbstractOdeSystemInformation.hpp

/*

Copyright (C) University of Oxford, 2005-2011

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

Chaste is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.

Chaste is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
License for more details. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/


#ifndef _ABSTRACTODESYSTEMINFORMATION_HPP_
#define _ABSTRACTODESYSTEMINFORMATION_HPP_

#include <vector>
#include <string>
#include <map>

class AbstractOdeSystemInformation
{
    friend class TestAbstractOdeSystem;

protected:
    std::string mSystemName;

    std::vector<std::string> mVariableNames;

    std::vector<std::string> mVariableUnits;

    std::vector<std::string> mParameterNames;

    std::vector<std::string> mParameterUnits;

    std::vector<std::string> mDerivedQuantityNames;

    std::vector<std::string> mDerivedQuantityUnits;

    std::map<std::string, double> mAttributes;

    std::vector<double> mInitialConditions;

    bool mInitialised;

    virtual void Initialise()=0;

public:

    AbstractOdeSystemInformation();

    virtual ~AbstractOdeSystemInformation();

    std::string GetSystemName() const;

    void SetDefaultInitialConditions(const std::vector<double>& rInitialConditions);

    void SetDefaultInitialCondition(unsigned index, double initialCondition);

    std::vector<double> GetInitialConditions() const;

    const std::vector<std::string>& rGetStateVariableNames() const;

    const std::vector<std::string>& rGetStateVariableUnits() const;

    unsigned GetStateVariableIndex(const std::string& rName) const;

    bool HasStateVariable(const std::string& rName) const;

    std::string GetStateVariableUnits(unsigned index) const;

    const std::vector<std::string>& rGetParameterNames() const;

    const std::vector<std::string>& rGetParameterUnits() const;

    unsigned GetParameterIndex(const std::string& rName) const;

    bool HasParameter(const std::string& rName) const;

    std::string GetParameterUnits(unsigned index) const;

    unsigned GetNumberOfParameters() const;

    unsigned GetAnyVariableIndex(const std::string& rName) const;

    bool HasAnyVariable(const std::string& rName) const;

    std::string GetAnyVariableUnits(unsigned index) const;

    const std::vector<std::string>& rGetDerivedQuantityNames() const;

    const std::vector<std::string>& rGetDerivedQuantityUnits() const;

    unsigned GetDerivedQuantityIndex(const std::string& rName) const;

    bool HasDerivedQuantity(const std::string& rName) const;

    std::string GetDerivedQuantityUnits(unsigned index) const;

    unsigned GetNumberOfDerivedQuantities() const;

    //
    // Attribute methods
    //

    unsigned GetNumberOfAttributes() const;

    bool HasAttribute(const std::string& rName) const;

    double GetAttribute(const std::string& rName) const;

};


#endif /*_ABSTRACTODESYSTEMINFORMATION_HPP_*/