ElectroMechanicsProblemDefinition.hpp

/*

Copyright (c) 2005-2016, 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 ELECTROMECHANICSPROBLEMDEFINITION_HPP_
#define ELECTROMECHANICSPROBLEMDEFINITION_HPP_

#include "SolidMechanicsProblemDefinition.hpp"
#include "ContractionModelName.hpp"
#include "NashHunterPoleZeroLaw.hpp"
#include "CompressibleExponentialLaw.hpp"
#include "FileFinder.hpp"
#include "AbstractContractionCellFactory.hpp"
#include "SolverType.hpp"

template<unsigned DIM>
class ElectroMechanicsProblemDefinition : public SolidMechanicsProblemDefinition<DIM>
{
private:
    friend class TestExplicitCardiacMechanicsSolver;
    friend class TestImplicitCardiacMechanicsSolver;
    friend class TestElectroMechanicsProblemDefinition;

    double mContractionModelOdeTimeStep;

    double mMechanicsSolveTimestep;

    bool mDeformationAffectsConductivity;

    bool mDeformationAffectsCellModels;

    AbstractMaterialLaw<DIM>* mpDefaultMaterialLaw;


    bool mReadFibreSheetInformationFromFile;

    FileFinder mFibreSheetDirectionsFile;

    bool mFibreSheetDirectionsDefinedPerQuadraturePoint;

    unsigned mNumIncrementsForInitialDeformation;

    bool mApplyCrossFibreTension;

    double mSheetTensionFraction;

    double mSheetNormalTensionFraction;

    AbstractContractionCellFactory<DIM>* mpContractionCellFactory;

    bool mWeMadeCellFactory;

    SolverType mSolverType;

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

    virtual ~ElectroMechanicsProblemDefinition();

    void SetContractionModel(ContractionModelName contractionModel, double timestep);

    void SetContractionCellFactory(AbstractContractionCellFactory<DIM>* pCellFactory);

    void SetUseDefaultCardiacMaterialLaw(CompressibilityType compressibilityType);

    void SetSolverType(SolverType solver)
    {
        mSolverType = solver;
    }

    void SetDeformationAffectsElectrophysiology(bool deformationAffectsConductivity, bool deformationAffectsCellModels);

    void SetMechanicsSolveTimestep(double timestep);


    void SetVariableFibreSheetDirectionsFile(const FileFinder& rFibreSheetDirectionsFile, bool definedPerQuadPoint);


    void SetApplyIsotropicCrossFibreTension(bool applyCrossFibreTension, double crossFibreTensionFraction);

    void SetApplyAnisotropicCrossFibreTension(bool applyCrossFibreTension, double sheetTensionFraction, double sheetNormalTensionFraction);

    AbstractContractionCellFactory<DIM>* GetContractionCellFactory()
    {
        assert(mpContractionCellFactory);
        return mpContractionCellFactory;
    }

    void SetContractionModelOdeTimestep(double timestep)
    {
        mContractionModelOdeTimeStep = timestep;
    }

    double GetContractionModelOdeTimestep()
    {
        assert(mContractionModelOdeTimeStep>0.0); // see exception message in Validate()
        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;
    }

    SolverType GetSolverType()
    {
        return mSolverType;
    }

    bool ReadFibreSheetDirectionsFromFile()
    {
        return mReadFibreSheetInformationFromFile;
    }

    FileFinder GetFibreSheetDirectionsFile()
    {
        assert(mReadFibreSheetInformationFromFile);
        assert(mFibreSheetDirectionsFile.GetAbsolutePath()!="");
        return mFibreSheetDirectionsFile;
    }

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

    void SetNumIncrementsForInitialDeformation(unsigned numIncrements)
    {
        if(numIncrements==0)
        {
            EXCEPTION("Number of increments for initial deformation must be 1 or more");
        }
        mNumIncrementsForInitialDeformation = numIncrements;
    }

    unsigned GetNumIncrementsForInitialDeformation()
    {
        return mNumIncrementsForInitialDeformation;
    }

    double GetApplyCrossFibreTension()
    {
        return mApplyCrossFibreTension;
    }

    double GetSheetTensionFraction()
    {
        return mSheetTensionFraction;
    }

    double GetSheetNormalTensionFraction()
    {
        return mSheetNormalTensionFraction;
    }


    virtual void Validate();
};

#endif // ELECTROMECHANICSPROBLEMDEFINITION_HPP_