MutableElement.hpp

/*
 
Copyright (c) 2005-2024, 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 MUTABLEELEMENT_HPP_
#define MUTABLEELEMENT_HPP_
 
#include "AbstractElement.hpp"
#include "Edge.hpp"
#include "EdgeHelper.hpp"
 
#include "ChasteSerialization.hpp"
#include <boost/serialization/base_object.hpp>
#include <boost/serialization/vector.hpp>
 
template<unsigned SPACE_DIM>
class EdgeHelper;
 
template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class MutableElement : public AbstractElement<ELEMENT_DIM, SPACE_DIM>
{
private:
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        archive & boost::serialization::base_object<AbstractElement<ELEMENT_DIM, SPACE_DIM> >(*this);
    }
 
protected:
 
    std::vector<Edge<SPACE_DIM>*> mEdges;
 
    EdgeHelper<SPACE_DIM>* mEdgeHelper;
 
public:
 
    MutableElement(unsigned index);
 
    MutableElement(unsigned index,
                  const std::vector<Node<SPACE_DIM>*>& rNodes);
 
 
    virtual ~MutableElement();
 
    void RegisterWithNodes();
 
    void MarkAsDeleted();
 
    void ResetIndex(unsigned index);
 
    void UpdateNode(const unsigned& rIndex, Node<SPACE_DIM>* pNode);
 
    void DeleteNode(const unsigned& rIndex);
 
    void AddNode(Node<SPACE_DIM>* pNode, const unsigned& rIndex);
 
    unsigned GetNodeLocalIndex(unsigned globalIndex) const;
 
    void RegisterWithEdges();
 
    void RebuildEdges();
 
    virtual bool IsElementOnBoundary() const;
 
    void SetEdgeHelper(EdgeHelper<SPACE_DIM>* pEdgeHelper);
 
    void ClearEdges();
 
    void BuildEdges();
 
    unsigned GetEdgeGlobalIndex(unsigned localIndex) const;
 
    Edge<SPACE_DIM>* GetEdge(unsigned localIndex) const;
 
    unsigned GetNumEdges() const;
 
    std::set<unsigned> GetNeighbouringElementAtEdgeIndex(unsigned localIndex);
 
    bool ContainsEdge(const Edge<SPACE_DIM>* pEdge) const;
 
    long GetLocalEdgeIndex(const Edge<SPACE_DIM>* pEdge) const;
};
 
//                  Specialization for 1d elements                  //
//                                                                  //
//                 1d elements are just edges (lines)               //
 
template<unsigned SPACE_DIM>
class MutableElement<1, SPACE_DIM> : public AbstractElement<1,SPACE_DIM>
{
protected:
 
    std::vector<Edge<SPACE_DIM>*> mEdges;
 
    EdgeHelper<SPACE_DIM>* mEdgeHelper;
 
public:
 
    MutableElement(unsigned index, const std::vector<Node<SPACE_DIM>*>& rNodes);
 
    MutableElement(unsigned index);
 
    virtual ~MutableElement();
 
    void UpdateNode(const unsigned& rIndex, Node<SPACE_DIM>* pNode);
 
    void RegisterWithNodes();
 
    void MarkAsDeleted();
 
    void ResetIndex(unsigned index);
 
    void DeleteNode(const unsigned& rIndex);
 
    void AddNode(Node<SPACE_DIM>* pNode, const unsigned& rIndex);
 
    Edge<SPACE_DIM>* GetEdge(unsigned localIndex) const;
 
    bool ContainsEdge(const Edge<SPACE_DIM>* pEdge) const;
 
    unsigned GetNumEdges() const;
 
    void SetEdgeHelper(EdgeHelper<SPACE_DIM>* pEdgeHelper);
 
    void BuildEdges();
 
    void ClearEdges();
 
    unsigned GetEdgeGlobalIndex(unsigned localIndex) const;
 
    std::set<unsigned> GetNeighbouringElementAtEdgeIndex(unsigned localIndex);
 
    unsigned GetNodeLocalIndex(unsigned globalIndex) const;
 
    void RegisterWithEdges();
 
    void RebuildEdges();
 
    virtual bool IsElementOnBoundary() const;
 
    long GetLocalEdgeIndex(const Edge<SPACE_DIM>* pEdge) const;
};
 
#endif /*MUTABLEELEMENT_HPP_*/