EvaluationArcTan.hpp

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 the LifeV library

   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 this library; if not, see <http://www.gnu.org/licenses/>


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

/*!
 *   @file
     @brief This file contains the definition of the EvaluationAddition class.

     @date 06/2011
     @author Samuel Quinodoz <samuel.quinodoz@epfl.ch>
 */

#ifndef EVALUTATION_ARCTAN_HPP
#define EVALUTATION_ARCTAN_HPP

#include <lifev/core/LifeV.hpp>

#include <lifev/eta/array/OperationSmallArcTan.hpp>
#include <lifev/eta/expression/ExpressionArcTan.hpp>

#include <lifev/core/fem/QuadratureRule.hpp>

namespace LifeV
{

namespace ExpressionAssembly
{

//! Evaluation for the product of two other Evaluations
/*!
  @author Samuel Quinodoz <samuel.quinodoz@epfl.ch>

  This class aims at representing a product operation during the assembly

  This class is an Evaluation class, and therefore, has all the methods
  required to work within the Evaluation trees.
 */
template <typename EvaluationBaseType>
class EvaluationArcTan
{
public:

    //! @name Public Types
    //@{
    typedef typename EvaluationBaseType::return_Type BaseReturn_Type;

    //! Type of the value returned by this class
    typedef typename OperationSmallArcTan<BaseReturn_Type>::result_Type return_Type;


    //@}


    //! @name Static constants
    //@{

    //! Flag for the global current FE
    const static flag_Type S_globalUpdateFlag;

    //! Flag for the test current FE
    const static flag_Type S_testUpdateFlag;

    //! Flag for the solution current FE
    const static flag_Type S_solutionUpdateFlag;

    //@}


    //! @name Constructors, destructor
    //@{

    //! Copy constructor
    EvaluationArcTan (const EvaluationArcTan& eval)
        : M_evaluationBase (eval.M_evaluationBase),
          M_epsilon (eval.M_epsilon),
          M_K (eval.M_K),
          M_delta (eval.M_delta)
    {}

    //! Constructor from the corresponding expression
    template <typename BaseExpressionType>
    explicit EvaluationArcTan (const ExpressionArcTan<BaseExpressionType>& expression)
        : M_evaluationBase (expression.base() ),
          M_epsilon (expression.epsilon() ),
          M_K (expression.K() ),
          M_delta (expression.delta() )
    {}

    //! Destructor
    ~EvaluationArcTan() {}

    //@}


    //! @name Methods
    //@{

    //! Internal update method
    void update (const UInt& iElement)
    {
        M_evaluationBase.update (iElement);
    }

    //! Display method
    static void display ( std::ostream& out = std::cout )
    {
        out << " atan ( " ;
        EvaluationBaseType::display (out);
        out << ")";
    }

    //@}


    //! @name Set Methods
    //@{

    //! Setter for the global current FE
    template< typename CFEType >
    void setGlobalCFE (const CFEType* globalCFE)
    {
        M_evaluationBase.setGlobalCFE (globalCFE);
    }

    //! Setter for the test current FE
    template< typename CFEType >
    void setTestCFE (const CFEType* testCFE)
    {
        M_evaluationBase.setTestCFE (testCFE);
    }

    //! Setter for the solution current FE
    template< typename CFEType >
    void setSolutionCFE (const CFEType* solutionCFE)
    {
        M_evaluationBase.setSolutionCFE (solutionCFE);
    }

    //! Setter for the quadrature rule
    void setQuadrature (const QuadratureRule& qr)
    {
        M_evaluationBase.setQuadrature (qr);
    }

    //@}


    //! @name Get Methods
    //@{

    //! Getter a value
    return_Type value_q (const UInt& q) const
    {
        return ( M_K ) * std::atan ( M_epsilon * ( M_evaluationBase.value_q (q) ) ) + ( M_delta );
    }

    //! Getter for the value for a vector
    return_Type value_qi (const UInt& q, const UInt& i) const
    {
        return ( M_K ) * std::atan ( M_epsilon * ( M_evaluationBase.value_qi (q, i) ) ) + ( M_delta );
    }

    //! Getter for the value for a matrix
    return_Type value_qij (const UInt& q, const UInt& i, const UInt& j) const
    {
        return ( M_K ) * std::atan ( M_epsilon * ( M_evaluationBase.value_qij (q, i, j) ) ) + ( M_delta );
    }

    //@}

private:

    //! @name Private Methods
    //@{

    //! No empty constructor
    EvaluationArcTan();

    //@}

    //! Internal storage
    EvaluationBaseType M_evaluationBase;
    Real M_epsilon;
    Real M_K;
    Real M_delta;
};

template< typename EvaluationBaseType>
const flag_Type EvaluationArcTan<EvaluationBaseType>::S_globalUpdateFlag
    = EvaluationBaseType::S_globalUpdateFlag;

template< typename EvaluationBaseType>
const flag_Type EvaluationArcTan<EvaluationBaseType>::S_testUpdateFlag
    = EvaluationBaseType::S_testUpdateFlag;

template< typename EvaluationBaseType>
const flag_Type EvaluationArcTan<EvaluationBaseType>::S_solutionUpdateFlag
    = EvaluationBaseType::S_solutionUpdateFlag;

} // Namespace ExpressionAssembly

} // Namespace LifeV
#endif