HeartConfigRelatedCellFactory.hpp

/*

Copyright (c) 2005-2012, 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 HEARTCONFIGRELATEDCELLFACTORY_HPP_
#define HEARTCONFIGRELATEDCELLFACTORY_HPP_

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

#include "AbstractCardiacCellFactory.hpp"
#include "HeartConfig.hpp"

#include "AbstractStimulusFunction.hpp"
#include "MultiStimulus.hpp" // Included here for archiving - see below.
#include "SimpleStimulus.hpp"

#include "ChasteCuboid.hpp"
#include "AbstractChasteRegion.hpp"

#include "DynamicCellModelLoader.hpp"

/*
 * Even though these classes are only used in the .cpp file, they need to be
 * included here for serialization to work - the archiving code needs to see
 * the CHASTE_CLASS_EXPORT incantations.
 */
#include "DiFrancescoNoble1985.hpp"
#include "FaberRudy2000.hpp"
#include "FaberRudy2000Opt.hpp"
#include "FoxModel2002.hpp"
#include "FoxModel2002BackwardEuler.hpp"
#include "HodgkinHuxley1952.hpp"
#include "LuoRudy1991.hpp"
#include "LuoRudy1991BackwardEuler.hpp"
#include "Mahajan2008.hpp"
#include "Mahajan2008BackwardEuler.hpp"
#include "Maleckar2008.hpp"
#include "TenTusscher2006Epi.hpp"
#include "TenTusscher2006EpiBackwardEuler.hpp"

/*
 * The following cell models aren't used by this class, but do exist in Chaste.
 * So users of the source code could see issues with archiving if they aren't included.
 */
#include "FoxModel2002Opt.hpp"
#include "LuoRudy1991Opt.hpp"
#include "Mahajan2008Opt.hpp"
#include "Maleckar2008Opt.hpp"
#include "NobleVargheseKohlNoble1998a.hpp"
#include "NobleVargheseKohlNoble1998aOpt.hpp"
#include "NobleVargheseKohlNoble1998aBackwardEuler.hpp"
#include "Shannon2004.hpp"
#include "TenTusscher2006EpiOpt.hpp"

template<unsigned SPACE_DIM>
class HeartConfigRelatedCellFactory : public AbstractCardiacCellFactory<SPACE_DIM>
{
private:
    cp::ionic_model_selection_type mDefaultIonicModel;
    std::vector<boost::shared_ptr<AbstractChasteRegion<SPACE_DIM> > > mIonicModelRegions;
    std::vector<cp::ionic_model_selection_type> mIonicModelsDefined;

    std::vector<boost::shared_ptr<AbstractChasteRegion<SPACE_DIM> > > mStimulatedAreas;
    std::vector<boost::shared_ptr<AbstractStimulusFunction> > mStimuliApplied;

    std::vector<boost::shared_ptr<AbstractChasteRegion<SPACE_DIM> > > mCellHeterogeneityAreas;
    std::vector<double> mScaleFactorGks;
    std::vector<double> mScaleFactorIto;
    std::vector<double> mScaleFactorGkr;

    std::vector<std::map<std::string, double> > mParameterSettings;

    void PreconvertCellmlFiles();

    DynamicCellModelLoaderPtr LoadDynamicModel(const cp::ionic_model_selection_type& rModel,
                                               bool isCollective);

public:
    HeartConfigRelatedCellFactory();

    ~HeartConfigRelatedCellFactory();

    AbstractCardiacCellInterface* CreateCellWithIntracellularStimulus(
            boost::shared_ptr<AbstractStimulusFunction> intracellularStimulus,
            unsigned nodeIndex);

    AbstractCardiacCellInterface* CreateCardiacCellForTissueNode(unsigned nodeIndex);

    void FillInCellularTransmuralAreas();

    void SetCellParameters(AbstractCardiacCellInterface* pCell, unsigned nodeIndex);

    void SetCellIntracellularStimulus(AbstractCardiacCellInterface* pCell, unsigned nodeIndex);
};


#endif /*HEARTCONFIGRELATEDCELLFACTORY_HPP_*/