CellBasedPdeHandler.hpp

/*

Copyright (C) University of Oxford, 2005-2011

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

#include <map>

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

#include "AbstractCellPopulation.hpp"
#include "PdeAndBoundaryConditions.hpp"
#include "TetrahedralMesh.hpp"
#include "Identifiable.hpp"

template<unsigned DIM>
class CellBasedPdeHandler : public Identifiable
{
    // Allow tests to access private members, in order to test computation of private functions
    friend class TestCellBasedPdeHandler;
    friend class TestOffLatticeSimulationWithPdes;

private:

    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        archive & mPdeAndBcCollection;
        archive & mWriteAverageRadialPdeSolution;
        archive & mWriteDailyAverageRadialPdeSolution;
        archive & mSetBcsOnCoarseBoundary;
        archive & mNumRadialIntervals;
    }

protected:

    AbstractCellPopulation<DIM>* mpCellPopulation;

    std::vector<PdeAndBoundaryConditions<DIM>*> mPdeAndBcCollection;

    out_stream mpVizPdeSolutionResultsFile;

    out_stream mpAverageRadialPdeSolutionResultsFile;

    bool mWriteAverageRadialPdeSolution;

    bool mWriteDailyAverageRadialPdeSolution;

    bool mSetBcsOnCoarseBoundary;

    unsigned mNumRadialIntervals;

    TetrahedralMesh<DIM,DIM>* mpCoarsePdeMesh;

    std::map<CellPtr, unsigned> mCellPdeElementMap;

    bool mDeleteMemberPointersInDestructor;

    void InitialiseCellPdeElementMap();

    virtual void WritePdeSolution(double time);

    void WriteAverageRadialPdeSolution(double time);

public:

    CellBasedPdeHandler(AbstractCellPopulation<DIM>* pCellPopulation, bool deleteMemberPointersInDestructor=false);

    virtual ~CellBasedPdeHandler();

    const AbstractCellPopulation<DIM>* GetCellPopulation() const;

    TetrahedralMesh<DIM,DIM>* GetCoarsePdeMesh();

    void OpenResultsFiles(std::string outputDirectory);

    void CloseResultsFiles();

    bool GetWriteAverageRadialPdeSolution();

    bool GetWriteDailyAverageRadialPdeSolution();

    void UpdateCellPdeElementMap();

    bool GetImposeBcsOnCoarseBoundary();

    unsigned GetNumRadialIntervals();

    virtual void SolvePdeAndWriteResultsToFile(unsigned samplingTimestepMultiple);

    unsigned FindCoarseElementContainingCell(CellPtr pCell);

    virtual Vec GetPdeSolution(unsigned pdeIndex);

    void SetWriteAverageRadialPdeSolution(unsigned numRadialIntervals=10,
                                          bool writeDailyResults=false);

    void SetImposeBcsOnCoarseBoundary(bool setBcsOnCoarseBoundary);

    virtual void UseCoarsePdeMesh(double stepSize, double meshWidth);

    void AddPdeAndBc(PdeAndBoundaryConditions<DIM>* pPdeAndBc);

    virtual void OutputParameters(out_stream& rParamsFile);
};

#include "SerializationExportWrapper.hpp"
EXPORT_TEMPLATE_CLASS_SAME_DIMS(CellBasedPdeHandler)

namespace boost
{
namespace serialization
{
template<class Archive, unsigned DIM>
inline void save_construct_data(
    Archive & ar, const CellBasedPdeHandler<DIM> * t, const BOOST_PFTO unsigned int file_version)
{
    // Save data required to construct instance
    const AbstractCellPopulation<DIM>* p_cell_population = t->GetCellPopulation();
    ar & p_cell_population;
}

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

    // Invoke inplace constructor to initialise instance
    ::new(t)CellBasedPdeHandler<DIM>(p_cell_population, true);
}
}
}

#endif /*CELLBASEDPDEHANDLER_HPP_*/