Node.hpp

/*

Copyright (C) University of Oxford, 2005-2010

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

#include "UblasVectorInclude.hpp"

#include <set>
#include <vector>

#include "ChastePoint.hpp"

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class AbstractTetrahedralMesh;

template<unsigned SPACE_DIM>
class Node
{
private:

    unsigned mIndex;

    unsigned mRegion;

    c_vector<double, SPACE_DIM> mLocation;

    bool mIsBoundaryNode;

    bool mIsDeleted;

    std::set<unsigned> mElementIndices;

    std::set<unsigned> mBoundaryElementIndices;

    void CommonConstructor(unsigned index, bool isBoundaryNode);

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);

    void SetPoint(ChastePoint<SPACE_DIM> point);

    void SetIndex(unsigned index);

    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);

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

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

    unsigned GetNumContainingElements() const;

    unsigned GetNumBoundaryElements() const;

    void MarkAsDeleted();

    bool IsDeleted() const;

    template <unsigned ELEMENT_DIM>
    bool IsFlagged(AbstractTetrahedralMesh<ELEMENT_DIM, SPACE_DIM>& rMesh)
    {
        bool in_flagged_element = false;
        for (ContainingElementIterator it = ContainingElementsBegin();
             it != ContainingElementsEnd();
             ++it)
        {
            if (rMesh.GetElement(*it)->IsFlagged())
            {
                in_flagged_element = true;
                break;
            }
        }
        return in_flagged_element;
    }

    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());
    }
};


#endif //_NODE_HPP_