lifev/electrophysiology/testsuite/test_0DHodgkinHuxley/main.cpp

Go to the documentation of this file.

//@HEADER
/*
*******************************************************************************

    Copyright (C) 2004, 2005, 2007 EPFL, Politecnico di Milano, INRIA
    Copyright (C) 2010 EPFL, Politecnico di Milano, Emory University

    This file is part of LifeV.

    LifeV 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 3 of the License, or
    (at your option) any later version.

    LifeV 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.

    You should have received a copy of the GNU Lesser General Public License
    along with LifeV.  If not, see <http://www.gnu.org/licenses/>.

*******************************************************************************
*/
//@HEADER

/*!
    @file
    @brief 0D test with the minimal model

    @date 01 - 2013
    @author Simone Rossi <simone.rossi@epfl.ch>

    @contributor
    @mantainer Simone Rossi <simone.rossi@epfl.ch>
 */

// Tell the compiler to ignore specific kind of warnings:
#pragma GCC diagnostic ignored "-Wunused-variable"
#pragma GCC diagnostic ignored "-Wunused-parameter"

#include <Epetra_ConfigDefs.h>
#ifdef EPETRA_MPI
#include <mpi.h>
#include <Epetra_MpiComm.h>
#else
#include <Epetra_SerialComm.h>
#endif

//Tell the compiler to restore the warning previously silented
#pragma GCC diagnostic warning "-Wunused-variable"
#pragma GCC diagnostic warning "-Wunused-parameter"


#include <fstream>

#include <lifev/electrophysiology/solver/IonicModels/IonicHodgkinHuxley.hpp>
#include <lifev/core/LifeV.hpp>

using namespace LifeV;

#define SolutionTestNorm  18208.651394522181363


Int main ( Int argc, char** argv )
{
    //********************************************//
    // Import parameters from an xml list. Use    //
    // Teuchos to create a list from a given file //
    // in the execution directory.                //
    //********************************************//
    std::cout << "Importing parameters list...";
    Teuchos::ParameterList parameterList = * ( Teuchos::getParametersFromXmlFile ( "HodgkinHuxleyParameters.xml" ) );
    std::cout << " Done!" << std::endl;

    //********************************************//
    // Creates a new model object representing the//
    // model from Hodgkin Huxley model.           //
    //********************************************//
    std::cout << "Building Constructor for Hodgkin Huxley Model with parameters ... ";
    IonicHodgkinHuxley  ionicModel (parameterList);
    std::cout << " Done!" << std::endl;

    //********************************************//
    // Show the parameters of the model as well as//
    // other informations  about the object.      //
    //********************************************//
    ionicModel.showMe();

    //********************************************//
    // Initialize the solution with the default   //
    // values                                     //
    //********************************************//
    std::cout << "Initializing solution vector...";
    std::vector<Real> states (ionicModel.Size(), 0);
    ionicModel.initialize (states);
    std::cout << " Done!" << std::endl;

    //********************************************//
    // Initialize the rhs to 0. The rhs is the    //
    // vector containing the numerical values of  //
    // the time derivatives of the state          //
    // variables, that is, the right hand side of //
    // the differential equation.                 //
    //********************************************//
    std::cout << "Initializing rhs..." ;
    std::vector<Real> rhs (ionicModel.Size(), 0);
    std::cout << " Done! "  << std::endl;

    //********************************************//
    // The model needs as external informations   //
    // the contraction velocity and the Calcium   //
    // concentration.                             //
    //********************************************//
    Real Iapp (0);

    //********************************************//
    // Simulation starts on t=0 and ends on t=TF. //
    // The timestep is given by dt                //
    //********************************************//
    Real TF (40);
    Real dt (0.005);
    int useRushLarsen (1);

    //********************************************//
    // Open the file "output.txt" to save the     //
    // solution.                                  //
    //********************************************//
    std::string filename = "output.txt";
    std::ofstream output ("output.txt");

    std::cout << "Potential: " << states.at (0) << std::endl;

    //********************************************//
    // We record the norm of the solution to      //
    // check the failure of the test              //
    //********************************************//
    Real SolutionNorm = states[0];

    //********************************************//
    // Time loop starts.                          //
    //********************************************//
    std::cout << "Time loop starts...\n";
    for ( Real t = 0; t < TF; )
    {
        //********************************************//
        // Compute the applied current. This is a     //
        // simple switch.                             //
        //********************************************//
        if ( t > 20.5 && t < 21 )
        {
            Iapp = 380.0;
        }
        else
        {
            Iapp = 0;
        }
        std::cout << "\r " << t << " ms.       " << std::flush;

        //********************************************//
        // Compute the rhs using the model equations  //
        //********************************************//
        ionicModel.setAppliedCurrent (Iapp);
        if (useRushLarsen)
        {
            ionicModel.computeGatingVariablesWithRushLarsen (states, dt);
            Real RHS = ionicModel.computeLocalPotentialRhs ( states);
            ionicModel.addAppliedCurrent (RHS);
            //********************************************//
            // Use forward Euler method to advance the    //
            // solution in time.                          //
            //********************************************//
            states[0] = states[0]  + dt * (RHS);
        }
        else
        {
            ionicModel.computeRhs ( states, rhs);
            rhs[0] += Iapp;

            //********************************************//
            // Use forward Euler method to advance the    //
            // solution in time.                          //
            //********************************************//
            for ( int j (0); j < ionicModel.Size(); j++)
            {
                states.at (j) = states.at (j)  + dt * rhs.at (j);
            }
        }


        //********************************************//
        // Writes solution on file.                   //
        //********************************************//
        output << t << ", ";
        for ( int j (0); j < ionicModel.Size() - 1; j++)
        {
            output << states.at (j) << ", ";
        }
        output << states.at ( ionicModel.Size() - 1 ) << "\n";

        //********************************************//
        // Update the time.                           //
        //********************************************//
        t = t + dt;

        //********************************************//
        // Update the norm of the solution to check   //
        // test failure                               //
        //********************************************//
        SolutionNorm += states[0];
    }
    std::cout << "\n...Time loop ends.\n";
    std::cout << "Solution written on file: " << filename << "\n";

    //********************************************//
    // Close exported file.                       //
    //********************************************//
    output.close();

    //********************************************//
    // Check if the test failed                   //
    //********************************************//
    Real returnValue;

    Real err = std::abs (SolutionTestNorm - SolutionNorm) / std::abs (SolutionTestNorm);
    std::cout << std::setprecision (20) << "\nError: " << err << "\nSolution norm: " << SolutionNorm << "\n";
    if ( err > 1e-12 )
    {
        std::cout << "\nTest Failed!\n";
        returnValue = EXIT_FAILURE; // Norm of solution did not match
    }
    else
    {
        returnValue = EXIT_SUCCESS;
    }
    return ( returnValue );
}


#undef SolutionTestNorm