ChastePoint.hpp

/*

Copyright (C) University of Oxford, 2005-2011

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

#include "ChasteSerialization.hpp"
#include "UblasVectorInclude.hpp"

#include <vector>

#include "Exception.hpp"

template<unsigned DIM>
class ChastePoint
{
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        //archive & mLocation; //earlier versions of boost are unable to do this. See #1709
    }
    
private:

    c_vector<double, DIM> mLocation;

public:

    ChastePoint(double v1=0, double v2=0, double v3=0);

    ChastePoint(std::vector<double> coords);

    ChastePoint(c_vector<double, DIM> location);

    c_vector<double, DIM>& rGetLocation();

    double operator[] (unsigned i) const;
    
    double GetWithDefault(unsigned i, double def=0.0) const;

    void SetCoordinate(unsigned i, double value);

    bool IsSamePoint(const ChastePoint<DIM>& rPoint) const;
};


#include "SerializationExportWrapper.hpp"
// Declare identifier for the serializer
EXPORT_TEMPLATE_CLASS_SAME_DIMS(ChastePoint)

namespace boost
{
namespace serialization
{

template<class Archive, unsigned SPACE_DIM>
inline void save_construct_data(
    Archive & ar, const ChastePoint<SPACE_DIM> * t, const BOOST_PFTO unsigned int file_version)
{
    for (unsigned i = 0; i < SPACE_DIM; i ++)
    {
        //we archive coordinates of mLocation one by one
        //this is because earlier version of boost (<1.40, I think) cannot archive c_vectors
        double coord = t->GetWithDefault(i);
        ar & coord;
    }
}

template<class Archive,unsigned SPACE_DIM>
inline void load_construct_data(
    Archive & ar, ChastePoint<SPACE_DIM> * t, const unsigned int file_version)
{
    std::vector<double> coords;
    coords.resize(SPACE_DIM);
    for (unsigned i = 0 ; i < SPACE_DIM; i ++)
    {
        double coordinate;
        ar & coordinate;//resume coordinates one by one
        coords[i] = coordinate;
    }
    //use constructor with standard vectors to re-build the object
     ::new(t)ChastePoint<SPACE_DIM>(coords);
}
}
} // namespace ...

template<>
class ChastePoint<0>
{
public:

    ChastePoint(double v1=0, double v2=0, double v3=0)
    {
    }

    double operator[] (unsigned i) const
    {
        EXCEPTION("Zero-dimensional point has no data");
    }
};


#endif //_CHASTEPOINT_HPP_

---