AbstractCellPopulationBoundaryCondition.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 #ifndef ABSTRACTCELLPOPULATIONBOUNDARYCONDITION_HPP_
00029 #define ABSTRACTCELLPOPULATIONBOUNDARYCONDITION_HPP_
00030 
00031 #include "AbstractCellPopulation.hpp"
00032 
00033 #include "ChasteSerialization.hpp"
00034 #include "ClassIsAbstract.hpp"
00035 #include "Identifiable.hpp"
00036 
00040 template<unsigned DIM>
00041 class AbstractCellPopulationBoundaryCondition : public Identifiable
00042 {
00043 private:
00045     friend class boost::serialization::access;
00052     template<class Archive>
00053     void serialize(Archive & archive, const unsigned int version)
00054     {
00055         // Archiving of mpCellPopulation is implemented in load_construct_data of subclasses
00056     }
00057 
00058 protected:
00059 
00061     AbstractCellPopulation<DIM>* mpCellPopulation;
00062 
00063 public:
00064 
00070     AbstractCellPopulationBoundaryCondition(AbstractCellPopulation<DIM>* pCellPopulation);
00071 
00075     virtual ~AbstractCellPopulationBoundaryCondition();
00076 
00083     virtual void ImposeBoundaryCondition()=0;
00084 
00095     virtual bool VerifyBoundaryCondition()=0;
00096 
00102     const AbstractCellPopulation<DIM>* GetCellPopulation() const;
00103 
00110     void OutputCellPopulationBoundaryConditionInfo(out_stream& rParamsFile);
00111 
00120     virtual void OutputCellPopulationBoundaryConditionParameters(out_stream& rParamsFile)=0;
00121 };
00122 
00123 TEMPLATED_CLASS_IS_ABSTRACT_1_UNSIGNED(AbstractCellPopulationBoundaryCondition)
00124 
00125 #endif /*ABSTRACTCELLPOPULATIONBOUNDARYCONDITION_HPP_*/

Generated on Tue May 31 14:31:40 2011 for Chaste by  doxygen 1.5.5