AbstractLinearPdeSolver.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 ABSTRACTLINEARPDESOLVER_HPP_
#define ABSTRACTLINEARPDESOLVER_HPP_

#include "LinearSystem.hpp"
#include "BoundaryConditionsContainer.hpp"
#include "AbstractTetrahedralMesh.hpp"
#include "HeartEventHandler.hpp"

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM>
class AbstractLinearPdeSolver : boost::noncopyable
{
protected:

    LinearSystem* mpLinearSystem;

    AbstractTetrahedralMesh<ELEMENT_DIM,SPACE_DIM>* mpMesh;

public:

    AbstractLinearPdeSolver(AbstractTetrahedralMesh<ELEMENT_DIM,SPACE_DIM>* pMesh)
        : mpLinearSystem(NULL),
          mpMesh(pMesh)
    {
        assert(pMesh!=NULL);
    }

    virtual ~AbstractLinearPdeSolver()
    {
        if (mpLinearSystem)
        {
            delete mpLinearSystem;
        }
    }

    virtual void InitialiseForSolve(Vec initialSolution = NULL);

    virtual void PrepareForSetupLinearSystem(Vec currentSolution)
    {
    }

    virtual void FinaliseLinearSystem(Vec currentSolution)
    {
    }

    virtual void FollowingSolveLinearSystem(Vec currentSolution)
    {
    }

    virtual void SetupLinearSystem(Vec currentSolution, bool computeMatrix)=0;

    LinearSystem* GetLinearSystem()
    {
        return mpLinearSystem;
    }
};

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM>
void AbstractLinearPdeSolver<ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM>::InitialiseForSolve(Vec initialSolution)
{
    if (this->mpLinearSystem == NULL)
    {
        unsigned preallocation=(mpMesh->CalculateMaximumContainingElementsPerProcess() + ELEMENT_DIM);
        if (ELEMENT_DIM > 1)
        {
            // Highest connectivity is closed
            preallocation--;
        }
        preallocation *= PROBLEM_DIM;

        HeartEventHandler::BeginEvent(HeartEventHandler::COMMUNICATION);
        if (initialSolution == NULL)
        {
            /*
             * Static problem, create linear system. The following ensures
             * all the unknowns for a particular node are on the same processor.
             */
            Vec template_vec = mpMesh->GetDistributedVectorFactory()->CreateVec(PROBLEM_DIM);

            this->mpLinearSystem = new LinearSystem(template_vec, preallocation);

            VecDestroy(template_vec);
        }
        else
        {
            /*
             * Use the current solution (ie the initial solution)
             * as the template in the alternative constructor of
             * LinearSystem. This is to avoid problems with VecScatter.
             */
            this->mpLinearSystem = new LinearSystem(initialSolution, preallocation);
        }

        HeartEventHandler::EndEvent(HeartEventHandler::COMMUNICATION);
    }
}

#endif /*ABSTRACTLINEARPDESOLVER_HPP_*/