VertexElement.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 VERTEXELEMENT_HPP_
#define VERTEXELEMENT_HPP_

#include "AbstractElement.hpp"

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

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class VertexElement : public AbstractElement<ELEMENT_DIM, SPACE_DIM>
{
private:

    std::vector<VertexElement<ELEMENT_DIM-1,SPACE_DIM>*> mFaces;

    std::vector<bool> mOrientations;

    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        // This needs to be first so that MeshBasedTissue::Validate() doesn't go mental.
        archive & mFaces;
        archive & mOrientations;
        archive & boost::serialization::base_object<AbstractElement<ELEMENT_DIM,SPACE_DIM> >(*this);
    }

public:

    VertexElement(unsigned index,
                  const std::vector<VertexElement<ELEMENT_DIM-1,SPACE_DIM>*>& rFaces,
                  const std::vector<bool>& rOrientations);

    VertexElement(unsigned index);

    VertexElement(unsigned index,
                  const std::vector<Node<SPACE_DIM>*>& rNodes);
    ~VertexElement();

    unsigned GetNumFaces() const;

    void RegisterWithNodes();

    void MarkAsDeleted();

    void ResetIndex(unsigned index);

    void UpdateNode(const unsigned& rIndex, Node<SPACE_DIM>* pNode);

    void DeleteNode(const unsigned& rIndex);

    void AddNode(const unsigned& rIndex, Node<SPACE_DIM>* pNode);

    void AddFace(VertexElement<ELEMENT_DIM-1,SPACE_DIM>* pFace);

    unsigned GetNodeLocalIndex(unsigned globalIndex);

    VertexElement<ELEMENT_DIM-1,SPACE_DIM>* GetFace(unsigned index) const;

    bool FaceIsOrientatedClockwise(unsigned index) const;

};

//                  Specialization for 1d elements                  //
//                                                                  //
//                 1d elements are just edges (lines)               //


template<unsigned SPACE_DIM>
class VertexElement<1, SPACE_DIM> : public AbstractElement<1,SPACE_DIM>
{
public:

    VertexElement(unsigned index, const std::vector<Node<SPACE_DIM>*>& rNodes);

    virtual ~VertexElement();

    unsigned GetNumFaces() const;

    void UpdateNode(const unsigned& rIndex, Node<SPACE_DIM>* pNode);

    void RegisterWithNodes();

    void MarkAsDeleted();

    void ResetIndex(unsigned index);

    void DeleteNode(const unsigned& rIndex);

    void AddNode(const unsigned& rIndex, Node<SPACE_DIM>* pNode);

    unsigned GetNodeLocalIndex(unsigned globalIndex);

    VertexElement<0,SPACE_DIM>* GetFace(unsigned index) const;

    bool FaceIsOrientatedClockwise(unsigned index) const;

};

#include <cassert>

template<unsigned SPACE_DIM>
VertexElement<1, SPACE_DIM>::VertexElement(unsigned index, const std::vector<Node<SPACE_DIM>*>& rNodes)
    : AbstractElement<1, SPACE_DIM>(index, rNodes)
{
    // Sanity checking
    assert(this->mNodes.size() == 2);
    assert(SPACE_DIM > 0);
}

template<unsigned SPACE_DIM>
VertexElement<1, SPACE_DIM>::~VertexElement()
{
}

template<unsigned SPACE_DIM>
unsigned VertexElement<1, SPACE_DIM>::GetNumFaces() const
{
    return 0;
}

template<unsigned SPACE_DIM>
void VertexElement<1, SPACE_DIM>::RegisterWithNodes()
{
    for (unsigned i=0; i<this->mNodes.size(); i++)
    {
        this->mNodes[i]->AddElement(this->mIndex);
    }
}

template<unsigned SPACE_DIM>
void VertexElement<1, SPACE_DIM>::MarkAsDeleted()
{
    // Mark element as deleted
    this->mIsDeleted = true;

    // Update nodes in the element so they know they are not contained by it
    for (unsigned i=0; i<this->GetNumNodes(); i++)
    {
        this->mNodes[i]->RemoveElement(this->mIndex);
    }
}

template <unsigned SPACE_DIM>
void VertexElement<1, SPACE_DIM>::ResetIndex(unsigned index)
{
    for (unsigned i=0; i<this->GetNumNodes(); i++)
    {
       this->mNodes[i]->RemoveElement(this->mIndex);
    }
    this->mIndex = index;
    RegisterWithNodes();
}

template<unsigned SPACE_DIM>
void VertexElement<1, SPACE_DIM>::UpdateNode(const unsigned& rIndex, Node<SPACE_DIM>* pNode)
{
    assert(rIndex < this->mNodes.size());

    // Remove it from the node at this location
    this->mNodes[rIndex]->RemoveElement(this->mIndex);

    // Update the node at this location
    this->mNodes[rIndex] = pNode;

    // Add element to this node
    this->mNodes[rIndex]->AddElement(this->mIndex);
}

template<unsigned SPACE_DIM>
void VertexElement<1, SPACE_DIM>::DeleteNode(const unsigned& rIndex)
{
    assert(rIndex < this->mNodes.size());

    // Remove element from the node at this location
    this->mNodes[rIndex]->RemoveElement(this->mIndex);

    // Remove the node at rIndex (removes node from element)
    this->mNodes.erase(this->mNodes.begin() + rIndex);
}

template<unsigned SPACE_DIM>
void VertexElement<1, SPACE_DIM>::AddNode(const unsigned& rIndex, Node<SPACE_DIM>* pNode)
{
    assert(rIndex < this->mNodes.size());

    // Add pNode to rIndex+1 element of mNodes pushing the others up
    this->mNodes.insert(this->mNodes.begin() + rIndex+1,  pNode);

    // Add element to this node
    this->mNodes[rIndex+1]->AddElement(this->mIndex);
}

template<unsigned SPACE_DIM>
unsigned VertexElement<1, SPACE_DIM>::GetNodeLocalIndex(unsigned globalIndex)
{
    unsigned local_index = UINT_MAX;
    for (unsigned i=0; i<this->mNodes.size(); i++)
    {
        if (this->GetNodeGlobalIndex(i) == globalIndex)
        {
            local_index = i;
        }
    }
    return local_index;
}

template<unsigned SPACE_DIM>
VertexElement<0, SPACE_DIM>* VertexElement<1, SPACE_DIM>::GetFace(unsigned index) const
{
    return NULL;
}

template<unsigned SPACE_DIM>
bool VertexElement<1, SPACE_DIM>::FaceIsOrientatedClockwise(unsigned index) const
{
    return false;
}

#endif /*VERTEXELEMENT_HPP_*/