ChasteNodesList.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 CHASTENODESLIST_HPP_
#define CHASTENODESLIST_HPP_

#include "ChasteSerialization.hpp"
#include <boost/serialization/base_object.hpp>

#include "AbstractChasteRegion.hpp"
#include "Node.hpp"
#include "ChastePoint.hpp"

#include <vector>
using namespace std;
template <unsigned SPACE_DIM>
class ChasteNodesList : public AbstractChasteRegion<SPACE_DIM>
{
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        archive & boost::serialization::base_object<AbstractChasteRegion<SPACE_DIM> >(*this);
    }

private:

    std::vector< Node<SPACE_DIM>*> mListOfNodes;

    bool mOwnNodes;

public:

    ChasteNodesList(const std::vector<Node<SPACE_DIM>*> rNodesList,
                    bool ownNodes=false);

    ~ChasteNodesList();

    const std::vector< Node<SPACE_DIM>*>& rGetNodesList() const;

    bool DoesContain(const ChastePoint<SPACE_DIM>& rPointToCheck) const;

    unsigned GetSize() const;

};

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

namespace boost
{
namespace serialization
{

template<class Archive, unsigned SPACE_DIM>
inline void save_construct_data(
    Archive & ar, const ChasteNodesList<SPACE_DIM> * t, const unsigned int file_version)
{
    const std::vector<Node<SPACE_DIM>* > node_list = t->rGetNodesList();

    // Archive the size first
    unsigned size = t->GetSize();
    ar & size;

    // The ChastePoints have to be at unique addresses, otherwise Boost thinks that the first archive is sufficient
    std::vector <ChastePoint<SPACE_DIM>* > point_list;

    for (unsigned i = 0; i < node_list.size(); i++)
    {
        c_vector<double, SPACE_DIM> loc =  node_list[i]->rGetLocation();
        point_list.push_back(new  ChastePoint<SPACE_DIM>(loc));
        ar & point_list[i];
        unsigned index = node_list[i]->GetIndex();
        ar & index;
    }

    // Clean memory
    for (unsigned i = 0; i < point_list.size(); i++)
    {
        delete point_list[i];
    }
}

template<class Archive, unsigned SPACE_DIM>
inline void load_construct_data(
    Archive & ar, ChasteNodesList<SPACE_DIM> * t, const unsigned int file_version)
{
    // Unarchive the size first
    unsigned size;
    ar & size;

    // Rebuild the node list based on the unarchived points and indices
    std::vector<Node<SPACE_DIM>* > node_list;
    for (unsigned i = 0; i < size; i++)
    {
        ChastePoint<SPACE_DIM>* p_point;
        unsigned index;
        ar & p_point;
        ar & index;

        Node<SPACE_DIM>* p_node = new Node<SPACE_DIM>( index, *(p_point));
        node_list.push_back(p_node);

        delete p_point; // not needed any longer
    }

    ::new(t)ChasteNodesList<SPACE_DIM>(node_list, true);
}
}
} // namespace ...

#endif /*CHASTENODESLIST_HPP_*/