Node.hpp

/*

Copyright (c) 2005-2018, University of Oxford.
All rights reserved.

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.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of the University of Oxford nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

#ifndef _NODE_HPP_
#define _NODE_HPP_

#include "UblasVectorInclude.hpp"

#include <set>
#include <vector>

#include "ChasteSerialization.hpp"
#include "ChastePoint.hpp"
#include "NodeAttributes.hpp"

//#include <boost/serialization/vector.hpp>
//#include <boost/serialization/set.hpp>

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class AbstractTetrahedralMesh;

template<unsigned SPACE_DIM>
class Node
{
private:

    unsigned mIndex;

    c_vector<double, SPACE_DIM> mLocation;

    NodeAttributes<SPACE_DIM>* mpNodeAttributes;

    bool mIsBoundaryNode;

    bool mIsInternal;

    bool mIsDeleted;

    std::set<unsigned> mElementIndices;

    std::set<unsigned> mBoundaryElementIndices;

    friend class boost::serialization::access;
    friend class TestNode;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        //archive & mLocation; //earlier versions of boost are unable to do this. See #1709
//        archive & mIndex;
        archive & mpNodeAttributes;
//        archive & mIsBoundaryNode;
//        archive & mIsInternal;
//        archive & mIsDeleted;
//        archive & mElementIndices;
//        archive & mBoundaryElementIndices;
    }

    void CommonConstructor(unsigned index, bool isBoundaryNode);

    void ConstructNodeAttributes();

    void CheckForNodeAttributes() const;

public:

    Node(unsigned index, ChastePoint<SPACE_DIM> point, bool isBoundaryNode=false);

    Node(unsigned index, std::vector<double> coords, bool isBoundaryNode=false);

    Node(unsigned index, c_vector<double, SPACE_DIM> location, bool isBoundaryNode=false);

    Node(unsigned index, bool isBoundaryNode=false, double v1=0, double v2=0, double v3=0);

    Node(unsigned index,  double *location, bool isBoundaryNode=false);

    ~Node();

    void SetPoint(ChastePoint<SPACE_DIM> point);

    void SetIndex(unsigned index);

    void AddNodeAttribute(double attribute);

    void SetAsBoundaryNode(bool value=true);

    ChastePoint<SPACE_DIM> GetPoint() const;

    const c_vector<double, SPACE_DIM>& rGetLocation() const;

    c_vector<double, SPACE_DIM>& rGetModifiableLocation();

    unsigned GetIndex() const;

    bool IsBoundaryNode() const;

    void AddElement(unsigned index);

    void RemoveElement(unsigned index);

    void RemoveBoundaryElement(unsigned index);

    void AddBoundaryElement(unsigned index);

    void AddNeighbour(unsigned index);

    void ClearNeighbours();

    void RemoveDuplicateNeighbours();

    bool NeighboursIsEmpty();

    void SetNeighboursSetUp(bool flag);

    bool GetNeighboursSetUp();

    std::vector<unsigned>& rGetNeighbours();

    std::set<unsigned>& rGetContainingElementIndices();

    std::vector<double>& rGetNodeAttributes();

    unsigned GetNumNodeAttributes();

    bool HasNodeAttributes();

    std::set<unsigned>& rGetContainingBoundaryElementIndices();

    unsigned GetNumContainingElements() const;

    unsigned GetNumBoundaryElements() const;

    c_vector<double, SPACE_DIM>& rGetAppliedForce();

    void ClearAppliedForce();

    void AddAppliedForceContribution(const c_vector<double, SPACE_DIM>& rForceContribution);

    bool IsParticle();

    void SetIsParticle(bool isParticle);

    double GetRadius();

    void SetRadius(double radius);

    void MarkAsDeleted();

    bool IsDeleted() const;

    void MarkAsInternal();

    bool IsInternal() const;

    void SetRegion(unsigned region);

    unsigned GetRegion() const;

    class ContainingElementIterator
    {
    public:
        ContainingElementIterator(std::set<unsigned>::const_iterator indexIterator)
            : mIndexIterator(indexIterator)
        {}
        const unsigned& operator*() const
        {
            return *mIndexIterator;
        }
        bool operator!=(const ContainingElementIterator& rOther) const
        {
            return mIndexIterator != rOther.mIndexIterator;
        }
        bool operator==(const ContainingElementIterator& rOther) const
        {
            return !operator!=(rOther);
        }
        ContainingElementIterator& operator++()
        {
            ++mIndexIterator;
            return *this;
        }
    private:
        std::set<unsigned>::const_iterator mIndexIterator;  
    };

    ContainingElementIterator ContainingElementsBegin() const
    {
        return ContainingElementIterator(mElementIndices.begin());
    }

    ContainingElementIterator ContainingElementsEnd() const
    {
        return ContainingElementIterator(mElementIndices.end());
    }

    class ContainingBoundaryElementIterator
    {
    public:
        ContainingBoundaryElementIterator(std::set<unsigned>::const_iterator indexIterator)
            : mIndexIterator(indexIterator)
        {}
        const unsigned& operator*() const
        {
            return *mIndexIterator;
        }
        bool operator!=(const ContainingBoundaryElementIterator& rOther) const
        {
            return mIndexIterator != rOther.mIndexIterator;
        }
        bool operator==(const ContainingBoundaryElementIterator& rOther) const
        {
            return !operator!=(rOther);
        }
        ContainingBoundaryElementIterator& operator++()
        {
            ++mIndexIterator;
            return *this;
        }
    private:
        std::set<unsigned>::const_iterator mIndexIterator;  
    };

    ContainingBoundaryElementIterator ContainingBoundaryElementsBegin() const
    {
        return ContainingBoundaryElementIterator(mBoundaryElementIndices.begin());
    }

    ContainingBoundaryElementIterator ContainingBoundaryElementsEnd() const
    {
        return ContainingBoundaryElementIterator(mBoundaryElementIndices.end());
    }
};

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

namespace boost
{
namespace serialization
{
template<class Archive, unsigned SPACE_DIM>
inline void save_construct_data(
    Archive & ar, const Node<SPACE_DIM> * t, const unsigned int file_version)
{

    // Save data required to construct instance
    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->rGetLocation()[i];
        ar & coord;
    }
    unsigned index = t->GetIndex();
    ar << index;

    bool is_boundary = t->IsBoundaryNode();
    ar << is_boundary;
}

template<class Archive, unsigned SPACE_DIM>
inline void load_construct_data(
    Archive & ar, Node<SPACE_DIM> * t, const unsigned int file_version)
{
    // Retrieve data from archive required to construct new instance of Node
    c_vector<double,SPACE_DIM> location;
    for (unsigned i=0; i<SPACE_DIM; i++)
    {
        double coordinate;
        ar & coordinate;//resume coordinates one by one
        location[i] = coordinate;
    }

    unsigned index;
    ar >> index;

    bool is_boundary;
    ar >> is_boundary;

    // Invoke inplace constructor to initialise instance
    ::new(t)Node<SPACE_DIM>(index, location, is_boundary);
}

}
} // namespace ...

#endif //_NODE_HPP_