ElectroMechanicsProblemDefinition.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 ELECTROMECHANICSPROBLEMDEFINITION_HPP_
#define ELECTROMECHANICSPROBLEMDEFINITION_HPP_

#include "SolidMechanicsProblemDefinition.hpp"
#include "ContractionModelName.hpp"
#include "NashHunterPoleZeroLaw.hpp"
#include "CompressibleExponentialLaw.hpp"



template<unsigned DIM>
class ElectroMechanicsProblemDefinition : public SolidMechanicsProblemDefinition<DIM>
{
private:
    ContractionModelName mContractionModel;

    double mContractionModelOdeTimeStep;

    double mMechanicsSolveTimestep;

    bool mDeformationAffectsConductivity;

    bool mDeformationAffectsCellModels;

    AbstractMaterialLaw<DIM>* mpDefaultMaterialLaw;


    bool mReadFibreSheetInformationFromFile;

    std::string mFibreSheetDirectionsFile;

    bool mFibreSheetDirectionsDefinedPerQuadraturePoint;

public:
    ElectroMechanicsProblemDefinition(QuadraticMesh<DIM>& rMesh);

    ~ElectroMechanicsProblemDefinition();

    void SetContractionModel(ContractionModelName contractionModel, double timestep);

    void SetUseDefaultCardiacMaterialLaw(CompressibilityType compressibilityType);

    void SetDeformationAffectsElectrophysiology(bool deformationAffectsConductivity, bool deformationAffectsCellModels);

    void SetMechanicsSolveTimestep(double timestep);


    void SetVariableFibreSheetDirectionsFile(std::string fibreSheetDirectionsFile, bool definedPerQuadPoint);


    ContractionModelName GetContractionModel()
    {
        assert(mContractionModelOdeTimeStep>0.0); // if this fails SetContractionModel() probably hasn't been called - call Validate() to check
        return mContractionModel;
    }

    double GetContractionModelOdeTimestep()
    {
        assert(mContractionModelOdeTimeStep>0.0); // if this fails SetContractionModel() probably hasn't been called - call Validate() to check
        return mContractionModelOdeTimeStep;
    }

    double GetMechanicsSolveTimestep()
    {
        assert(mMechanicsSolveTimestep>0.0); // if this fails SetMechanicsSolveTimestep() probably hasn't been called - call Validate() to check
        return mMechanicsSolveTimestep;
    }

    bool GetDeformationAffectsConductivity()
    {
        return mDeformationAffectsConductivity;
    }

    bool GetDeformationAffectsCellModels()
    {
        return mDeformationAffectsCellModels;
    }

    bool ReadFibreSheetDirectionsFromFile()
    {
        return mReadFibreSheetInformationFromFile;
    }

    std::string GetFibreSheetDirectionsFile()
    {
        assert(mReadFibreSheetInformationFromFile);
        assert(mFibreSheetDirectionsFile!="");
        return mFibreSheetDirectionsFile;
    }

    bool GetFibreSheetDirectionsDefinedPerQuadraturePoint()
    {
        assert(mReadFibreSheetInformationFromFile);
        return mFibreSheetDirectionsDefinedPerQuadraturePoint;
    }

    virtual void Validate();
};

#endif // ELECTROMECHANICSPROBLEMDEFINITION_HPP_