Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractCvodeCellWithDataClamp.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
16 * Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19 * Neither the name of the University of Oxford nor the names of its
20 contributors may be used to endorse or promote products derived from this
21 software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifdef CHASTE_CVODE
37#ifndef _ABSTRACTCVODECELLWITHDATACLAMP_HPP_
38#define _ABSTRACTCVODECELLWITHDATACLAMP_HPP_
39
40#include "AbstractCvodeCell.hpp"
41
52{
53private:
56
59
66 template<class Archive>
67 void serialize(Archive & archive, const unsigned int version)
68 {
69 // This calls serialize on the base class.
70 archive & boost::serialization::base_object<AbstractCvodeCell>(*this);
71
72 // Archive this class' member variables.
73 archive & mExperimentalTimes;
74 archive & mExperimentalVoltages;
75 archive & mDataClampIsOn;
76 archive & mDataAvailable;
77 }
78
80 std::vector<double> mExperimentalTimes;
81
83 std::vector<double> mExperimentalVoltages;
84
87
88protected:
89
92
99 double GetExperimentalVoltageAtTimeT(const double& rTime);
100
101public:
110 AbstractCvodeCellWithDataClamp(boost::shared_ptr<AbstractIvpOdeSolver> pSolver,
111 unsigned numberOfStateVariables,
112 unsigned voltageIndex,
113 boost::shared_ptr<AbstractStimulusFunction> pIntracellularStimulus);
114
119
128 void SetExperimentalData(std::vector<double> experimentalTimes,
129 std::vector<double> experimentalVoltages);
130
131
135 void TurnOffDataClamp();
136
142 void TurnOnDataClamp(double conductance = 100);
143};
144
146
147#endif // _ABSTRACTCVODECELLWITHDATACLAMP_HPP_
148#endif // CHASTE_CVODE
#define CLASS_IS_ABSTRACT(T)
void SetExperimentalData(std::vector< double > experimentalTimes, std::vector< double > experimentalVoltages)
double GetExperimentalVoltageAtTimeT(const double &rTime)
void serialize(Archive &archive, const unsigned int version)
friend class boost::serialization::access