HeartConfig.hpp

/*

Copyright (C) University of Oxford, 2005-2009

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 HEARTCONFIG_HPP_
#define HEARTCONFIG_HPP_

#include <string>
#include <vector>

#include "UblasIncludes.hpp"

#include "ArchiveLocationInfo.hpp"
#include "ChasteParameters.hpp"
#include "SimpleStimulus.hpp"
#include "ChasteCuboid.hpp"

#include <boost/shared_ptr.hpp>

#include <boost/serialization/access.hpp>
#include <boost/serialization/split_member.hpp>

// Needs to be included last
#include <boost/serialization/export.hpp>


class HeartConfig
{
private:
    void CheckTimeSteps() const;

    friend class boost::serialization::access;
    template<class Archive>
    void save(Archive & archive, const unsigned int version) const
    {
        mpInstance->Write( true );
    }

    template<class Archive>
    void load(Archive & archive, const unsigned int version)
    {
        std::string defaults_filename_xml = ArchiveLocationInfo::GetArchiveDirectory() + "ChasteDefaults.xml";
        HeartConfig::Instance()->SetDefaultsFile(defaults_filename_xml);

        std::string parameters_filename_xml = ArchiveLocationInfo::GetArchiveDirectory() + "ChasteParameters.xml";
        HeartConfig::Instance()->SetParametersFile(parameters_filename_xml);
    }
    BOOST_SERIALIZATION_SPLIT_MEMBER()



public:
    static HeartConfig* Instance();

    void SetUseFixedSchemaLocation(bool useFixedSchemaLocation);

    void SetDefaultsFile(const std::string& rFileName);
    void SetParametersFile(const std::string& rFileName);
    void Write(bool useArchiveLocationInfo=false);

    static void Reset();

    /*
     *  Get methods
     */
    // Simulation
    unsigned GetSpaceDimension() const; 
    double GetSimulationDuration() const; 
    domain_type GetDomain() const;
    ionic_models_available_type GetDefaultIonicModel() const;

     void GetIonicModelRegions(std::vector<ChasteCuboid>& definedRegions,
                               std::vector<ionic_models_available_type>& ionicModels) const;


    bool IsMeshProvided() const; 
    bool GetCreateMesh() const; 
    bool GetCreateSlab() const; 
    bool GetCreateSheet() const; 
    bool GetCreateFibre() const; 
    bool GetLoadMesh() const; 


    void GetSlabDimensions(c_vector<double, 3>& slabDimensions) const;
    void GetSheetDimensions(c_vector<double, 2>& sheetDimensions) const;
    void GetFibreLength(c_vector<double, 1>& fibreLength) const;
    double GetInterNodeSpace() const; 
    std::string GetMeshName() const;
    media_type GetConductivityMedia() const;
    void GetStimuli(std::vector<boost::shared_ptr<SimpleStimulus> >& rStimuliApplied, std::vector<ChasteCuboid>& rStimulatedAreas) const;

    void GetCellHeterogeneities(std::vector<ChasteCuboid>& cellHeterogeneityAreas,
                                std::vector<double>& scaleFactorGks,
                                std::vector<double>& scaleFactorIto,
                                std::vector<double>& scaleFactorGkr) const;
    bool GetConductivityHeterogeneitiesProvided() const; 
    void GetConductivityHeterogeneities(std::vector<ChasteCuboid>& conductivitiesHeterogeneityAreas,
                                        std::vector< c_vector<double,3> >& intraConductivities,
                                        std::vector< c_vector<double,3> >& extraConductivities) const;
    std::string GetOutputDirectory() const; std::string GetOutputFilenamePrefix() const;

    // Physiological
    void GetIntracellularConductivities(c_vector<double, 3>& intraConductivities) const;
    void GetIntracellularConductivities(c_vector<double, 2>& intraConductivities) const;
    void GetIntracellularConductivities(c_vector<double, 1>& intraConductivities) const;

    void GetExtracellularConductivities(c_vector<double, 3>& extraConductivities) const;
    void GetExtracellularConductivities(c_vector<double, 2>& extraConductivities) const;
    void GetExtracellularConductivities(c_vector<double, 1>& extraConductivities) const;

    double GetBathConductivity() const; 
    double GetSurfaceAreaToVolumeRatio() const; 
    double GetCapacitance() const; 
    // Numerical
    double GetOdeTimeStep() const; 
    double GetPdeTimeStep() const; 
    double GetPrintingTimeStep() const; 
    bool GetUseAbsoluteTolerance() const; 
    double GetAbsoluteTolerance() const; 
    bool GetUseRelativeTolerance() const; 
    double GetRelativeTolerance() const;  
    const char* GetKSPSolver() const; 
    const char* GetKSPPreconditioner() const; 
    // Post processing
    bool IsPostProcessingRequested() const;

    bool IsApdMapsRequested() const;
    void GetApdMaps(std::vector<std::pair<double,double> >& apd_maps) const;

    bool IsUpstrokeTimeMapsRequested() const;
    void GetUpstrokeTimeMaps (std::vector<double>& upstroke_time_maps) const;

    bool IsMaxUpstrokeVelocityMapRequested() const;

    bool IsConductionVelocityMapsRequested() const;

    void GetConductionVelocityMaps(std::vector<unsigned>& conduction_velocity_maps) const;


    /*
     *  Set methods
     */
    // Simulation
    void SetSpaceDimension(unsigned spaceDimension);
    void SetSimulationDuration(double simulationDuration);
    void SetDomain(domain_type domain);
    void SetDefaultIonicModel(ionic_models_available_type ionicModel);

    void SetSlabDimensions(double x, double y, double z, double inter_node_space);
    void SetSheetDimensions(double x, double y, double inter_node_space);
    void SetFibreLength(double x, double inter_node_space);

    void SetMeshFileName(std::string meshPrefix, media_type fibreDefinition=media_type::NoFibreOrientation);

    void SetConductivityHeterogeneities(std::vector< c_vector<double,3> >& cornerA,
                                        std::vector< c_vector<double,3> >& cornerB,
                                        std::vector< c_vector<double,3> >& intraConductivities,
                                        std::vector< c_vector<double,3> >& extraConductivities);

    void SetOutputDirectory(const std::string& rOutputDirectory);
    void SetOutputFilenamePrefix(const std::string& rOutputFilenamePrefix);

    // Physiological
    void SetIntracellularConductivities(const c_vector<double, 3>& intraConductivities);
    void SetIntracellularConductivities(const c_vector<double, 2>& intraConductivities);
    void SetIntracellularConductivities(const c_vector<double, 1>& intraConductivities);

    void SetExtracellularConductivities(const c_vector<double, 3>& extraConductivities);
    void SetExtracellularConductivities(const c_vector<double, 2>& extraConductivities);
    void SetExtracellularConductivities(const c_vector<double, 1>& extraConductivities);

    void SetBathConductivity(double bathConductivity);

    void SetSurfaceAreaToVolumeRatio(double ratio);

    void SetCapacitance(double capacitance);

    // Numerical
    void SetOdePdeAndPrintingTimeSteps(double odeTimeStep, double pdeTimeStep, double printingTimeStep);
    void SetOdeTimeStep(double odeTimeStep);
    void SetPdeTimeStep(double pdeTimeStep);

     void SetPrintingTimeStep(double printingTimeStep);

    void SetUseRelativeTolerance(double relativeTolerance);
    void SetUseAbsoluteTolerance(double absoluteTolerance);

    void SetKSPSolver(const char* kspSolver);
    void SetKSPPreconditioner(const char* kspPreconditioner);

    void SetApdMaps(const std::vector<std::pair<double,double> >& apd_maps);

    void SetUpstrokeTimeMaps (std::vector<double>& upstroke_time_maps);

    ~HeartConfig(); 
protected:
    // Only to be accessed by the tests
    friend class TestHeartConfig;

private:
    /*Constructor is private, since the class is only accessed by the singleton instance() method*/
    HeartConfig();

    boost::shared_ptr<chaste_parameters_type> mpUserParameters;
    boost::shared_ptr<chaste_parameters_type> mpDefaultParameters;

    static std::auto_ptr<HeartConfig> mpInstance;
    
    bool mUseFixedSchemaLocation;

    template<class TYPE>
    TYPE* DecideLocation(TYPE* params_ptr, TYPE* defaults_ptr, const std::string& nameParameter) const;

    boost::shared_ptr<chaste_parameters_type> ReadFile(const std::string& rFileName);

};

// Declare identifier for the serializer
BOOST_CLASS_EXPORT(HeartConfig);

#endif /*HEARTCONFIG_HPP_*/

---