AbstractParameterisedSystem.hpp

/*

Copyright (c) 2005-2018, University of Oxford.
All rights reserved.

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.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of the University of Oxford nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

#ifndef ABSTRACTPARAMETERISEDSYSTEM_HPP_
#define ABSTRACTPARAMETERISEDSYSTEM_HPP_

#include <vector>
#include <string>
#include <boost/shared_ptr.hpp>

#include "AbstractUntemplatedParameterisedSystem.hpp"


template<typename VECTOR>
class AbstractParameterisedSystem : public AbstractUntemplatedParameterisedSystem
{
friend class TestAbstractCvodeSystem;

private:
    std::string GetStateMessage(const std::string& rMessage, VECTOR Y);

protected:
    VECTOR mStateVariables;

    VECTOR mParameters;

    std::string DumpState(const std::string& rMessage);

    std::string DumpState(const std::string& rMessage,
                          VECTOR Y);

    std::string DumpState(const std::string& rMessage,
                          VECTOR Y,
                          double time);

    void CheckParametersOnLoad(const std::vector<double>& rParameters,
                               const std::vector<std::string>& rParameterNames);

public:
    AbstractParameterisedSystem(unsigned numberOfStateVariables);

    //
    // State variable methods
    //

    VECTOR& rGetStateVariables();

    VECTOR GetStateVariables();

    void SetStateVariables(const VECTOR& rStateVariables);

    double GetStateVariable(unsigned index) const;

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

    void SetStateVariable(unsigned index, double newValue);

    void SetStateVariable(const std::string& rName, double newValue);

    virtual void VerifyStateVariables()
    {}

    //
    // Initial condition methods
    //

    void SetDefaultInitialConditions(const VECTOR& rInitialConditions);

    void SetDefaultInitialCondition(unsigned index, double initialCondition);

    VECTOR GetInitialConditions() const;

    void ResetToInitialConditions();

    //
    // Parameter methods
    //

    double GetParameter(unsigned index) const;

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

    void SetParameter(const std::string& rName, double value);

    void SetParameter(unsigned index, double value);

    //
    // "Any variable" methods
    //

    double GetAnyVariable(unsigned index, double time=0.0,
                          VECTOR* pDerivedQuantities=NULL);

    double GetAnyVariable(const std::string& rName, double time=0.0,
                          VECTOR* pDerivedQuantities=NULL);

    void SetAnyVariable(unsigned index, double value);

    void SetAnyVariable(const std::string& rName, double value);

    //
    // Derived quantity methods
    //

    virtual VECTOR ComputeDerivedQuantities(double time,
                                            const VECTOR& rState);

    VECTOR ComputeDerivedQuantitiesFromCurrentState(double time);
};

#endif /*ABSTRACTPARAMETERISEDSYSTEM_HPP_*/