VertexBasedCellPopulation.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 VERTEXBASEDCELLPOPULATION_HPP_
#define VERTEXBASEDCELLPOPULATION_HPP_

#include "AbstractOffLatticeCellPopulation.hpp"
#include "MutableVertexMesh.hpp"

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

template<unsigned DIM>
class AbstractVertexBasedDivisionRule; // Forward declaration to prevent circular include chain

template<unsigned DIM>
class VertexBasedCellPopulation : public AbstractOffLatticeCellPopulation<DIM>
{
private:

    friend class TestVertexBasedDivisionRules;

    bool mDeleteMesh;

    MutableVertexMesh<DIM, DIM>* mpMutableVertexMesh;

    bool mOutputCellRearrangementLocations;

    boost::shared_ptr<AbstractVertexBasedDivisionRule<DIM> > mpVertexBasedDivisionRule;

    std::vector< c_vector<double, DIM> > mLocationsOfT2Swaps;

    std::vector< unsigned > mCellIdsOfT2Swaps;

    bool mRestrictVertexMovement;

    virtual void WriteVtkResultsToFile(const std::string& rDirectory);

    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        archive & boost::serialization::base_object<AbstractOffLatticeCellPopulation<DIM> >(*this);
        archive & mOutputCellRearrangementLocations;
        archive & mpVertexBasedDivisionRule;
        archive & mRestrictVertexMovement;
    }

    void Validate();

public:

    VertexBasedCellPopulation(MutableVertexMesh<DIM, DIM>& rMesh,
                              std::vector<CellPtr>& rCells,
                              bool deleteMesh=false,
                              bool validate=true,
                              const std::vector<unsigned> locationIndices=std::vector<unsigned>());

    VertexBasedCellPopulation(MutableVertexMesh<DIM, DIM>& rMesh);

    virtual ~VertexBasedCellPopulation();

    double GetDampingConstant(unsigned nodeIndex);

    MutableVertexMesh<DIM, DIM>& rGetMesh();

    const MutableVertexMesh<DIM, DIM>& rGetMesh() const;

    VertexElement<DIM, DIM>* GetElement(unsigned elementIndex);

    unsigned GetNumElements();

    unsigned GetNumNodes();

    c_vector<double, DIM> GetLocationOfCellCentre(CellPtr pCell);

    Node<DIM>* GetNode(unsigned index);

    std::set<unsigned> GetNeighbouringLocationIndices(CellPtr pCell);

    unsigned AddNode(Node<DIM>* pNewNode);

    virtual void CheckForStepSizeException(unsigned nodeIndex, c_vector<double,DIM>& rDisplacement, double dt);

    void SetNode(unsigned index, ChastePoint<DIM>& rNewLocation);

    VertexElement<DIM, DIM>* GetElementCorrespondingToCell(CellPtr pCell);

    CellPtr AddCell(CellPtr pNewCell, CellPtr pParentCell=CellPtr());

    unsigned RemoveDeadCells();

    bool IsCellAssociatedWithADeletedLocation(CellPtr pCell);

    void Update(bool hasHadBirthsOrDeaths=true);

    virtual void OpenWritersFiles(OutputFileHandler& rOutputFileHandler);

    virtual void AcceptPopulationWriter(boost::shared_ptr<AbstractCellPopulationWriter<DIM, DIM> > pPopulationWriter);

    virtual void AcceptPopulationCountWriter(boost::shared_ptr<AbstractCellPopulationCountWriter<DIM, DIM> > pPopulationCountWriter);

    virtual void AcceptCellWriter(boost::shared_ptr<AbstractCellWriter<DIM, DIM> > pCellWriter, CellPtr pCell);

    unsigned GetRosetteRankOfCell(CellPtr pCell);

    double GetVolumeOfCell(CellPtr pCell);

    std::vector< c_vector< double, DIM > > GetLocationsOfT2Swaps();

    std::vector< unsigned > GetCellIdsOfT2Swaps();

    void AddLocationOfT2Swap(c_vector< double, DIM> locationOfT2Swap);

    void AddCellIdOfT2Swap(unsigned idOfT2Swap);

    void ClearLocationsAndCellIdsOfT2Swaps();

    bool GetOutputCellRearrangementLocations();

    void SetOutputCellRearrangementLocations(bool outputCellRearrangementLocations);

    void OutputCellPopulationParameters(out_stream& rParamsFile);

    double GetWidth(const unsigned& rDimension);

    std::set<unsigned> GetNeighbouringNodeIndices(unsigned index);

    virtual TetrahedralMesh<DIM, DIM>* GetTetrahedralMeshForPdeModifier();

    virtual bool IsPdeNodeAssociatedWithNonApoptoticCell(unsigned pdeNodeIndex);

    virtual double GetCellDataItemAtPdeNode(unsigned pdeNodeIndex,
                                            std::string& rVariableName,
                                            bool dirichletBoundaryConditionApplies=false,
                                            double dirichletBoundaryValue=0.0);

    boost::shared_ptr<AbstractVertexBasedDivisionRule<DIM> > GetVertexBasedDivisionRule();

    void SetVertexBasedDivisionRule(boost::shared_ptr<AbstractVertexBasedDivisionRule<DIM> > pVertexBasedDivisionRule);

    virtual double GetDefaultTimeStep();

    virtual void WriteDataToVisualizerSetupFile(out_stream& pVizSetupFile);

    virtual void SimulationSetupHook(AbstractCellBasedSimulation<DIM, DIM>* pSimulation);

    bool GetRestrictVertexMovementBoolean();

    void SetRestrictVertexMovementBoolean(bool restrictVertexMovement);
};

#include "SerializationExportWrapper.hpp"
EXPORT_TEMPLATE_CLASS_SAME_DIMS(VertexBasedCellPopulation)

namespace boost
{
namespace serialization
{
template<class Archive, unsigned DIM>
inline void save_construct_data(
    Archive & ar, const VertexBasedCellPopulation<DIM> * t, const unsigned int file_version)
{
    // Save data required to construct instance
    const MutableVertexMesh<DIM,DIM>* p_mesh = &(t->rGetMesh());
    ar & p_mesh;
}

template<class Archive, unsigned DIM>
inline void load_construct_data(
    Archive & ar, VertexBasedCellPopulation<DIM> * t, const unsigned int file_version)
{
    // Retrieve data from archive required to construct new instance
    MutableVertexMesh<DIM,DIM>* p_mesh;
    ar >> p_mesh;

    // Invoke inplace constructor to initialise instance
    ::new(t)VertexBasedCellPopulation<DIM>(*p_mesh);
}
}
} // namespace ...

#endif /*VERTEXBASEDCELLPOPULATION_HPP_*/