PlaneBoundaryCondition.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 PLANEBOUNDARYCONDITION_HPP_
00029 #define PLANEBOUNDARYCONDITION_HPP_
00030 
00031 #include "AbstractCellPopulationBoundaryCondition.hpp"
00032 
00033 #include "ChasteSerialization.hpp"
00034 #include <boost/serialization/base_object.hpp>
00035 #include <boost/serialization/vector.hpp>
00036 
00043 template<unsigned DIM>
00044 class PlaneBoundaryCondition : public AbstractCellPopulationBoundaryCondition<DIM>
00045 {
00046 private:
00047 
00051     c_vector<double, DIM> mPointOnPlane;
00052 
00056     c_vector<double, DIM> mNormalToPlane;
00057 
00059     friend class boost::serialization::access;
00066     template<class Archive>
00067     void serialize(Archive & archive, const unsigned int version)
00068     {
00069         archive & boost::serialization::base_object<AbstractCellPopulationBoundaryCondition<DIM> >(*this);
00070     }
00071 
00072 public:
00073 
00081     PlaneBoundaryCondition(AbstractCellPopulation<DIM>* pCellPopulation,
00082                            c_vector<double, DIM> point,
00083                            c_vector<double, DIM> normal);
00084 
00088     const c_vector<double, DIM>& rGetPointOnPlane() const;
00089 
00093     const c_vector<double, DIM>& rGetNormalToPlane() const;
00094 
00100     void ImposeBoundaryCondition();
00101 
00109     bool VerifyBoundaryCondition();
00110 
00117     void OutputCellPopulationBoundaryConditionParameters(out_stream& rParamsFile);
00118 };
00119 
00120 #include "SerializationExportWrapper.hpp"
00121 EXPORT_TEMPLATE_CLASS_SAME_DIMS(PlaneBoundaryCondition)
00122 
00123 namespace boost
00124 {
00125 namespace serialization
00126 {
00130 template<class Archive, unsigned DIM>
00131 inline void save_construct_data(
00132     Archive & ar, const PlaneBoundaryCondition<DIM> * t, const BOOST_PFTO unsigned int file_version)
00133 {
00134     // Save data required to construct instance
00135     const AbstractCellPopulation<DIM>* const p_cell_population = t->GetCellPopulation();
00136     ar << p_cell_population;
00137 
00138     // Archive c_vectors one component at a time
00139     c_vector<double, DIM> point = t->rGetPointOnPlane();
00140     for (unsigned i=0; i<DIM; i++)
00141     {
00142         ar << point[i];
00143     }
00144     c_vector<double, DIM> normal = t->rGetNormalToPlane();
00145     for (unsigned i=0; i<DIM; i++)
00146     {
00147         ar << normal[i];
00148     }
00149 }
00150 
00154 template<class Archive, unsigned DIM>
00155 inline void load_construct_data(
00156     Archive & ar, PlaneBoundaryCondition<DIM> * t, const unsigned int file_version)
00157 {
00158     // Retrieve data from archive required to construct new instance
00159     AbstractCellPopulation<DIM>* p_cell_population;
00160     ar >> p_cell_population;
00161 
00162     // Archive c_vectors one component at a time
00163     c_vector<double, DIM> point;
00164     for (unsigned i=0; i<DIM; i++)
00165     {
00166         ar >> point[i];
00167     }
00168     c_vector<double, DIM> normal;
00169     for (unsigned i=0; i<DIM; i++)
00170     {
00171         ar >> normal[i];
00172     }
00173 
00174     // Invoke inplace constructor to initialise instance
00175     ::new(t)PlaneBoundaryCondition<DIM>(p_cell_population, point, normal);
00176 }
00177 }
00178 } // namespace ...
00179 
00180 #endif /*PLANEBOUNDARYCONDITION_HPP_*/

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