ExpressionArcTan.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 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 File where the structures for the product between expressions are defined.

    @author Samuel Quinodoz <samuel.quinodoz@epfl.ch>

    @date 07-2011
 */

#ifndef EXPRESSION_ARCTAN_HPP
#define EXPRESSION_ARCTAN_HPP

#include <lifev/core/LifeV.hpp>

#include <lifev/eta/expression/ExpressionBase.hpp>

namespace LifeV
{

namespace ExpressionAssembly
{

//! class ExpressionPower  Class for representing a product between two expressions.
/*!
  @author Samuel Quinodoz <samuel.quinodoz@epfl.ch>

  This class represents the product in the expression tree.

  <b> Template parameters </b>

  <i>LExpressionType</i>: The expression on the left side of the product operation.

  <i>RExpressionType</i>: The expression on the right side of the product operation.

  <b> Template requirements </b>

  <i>LExpressionType</i>: Copiable, static display method

  <i>RExpressionType</i>: Copiable, static display method

*/
template <typename BaseExpressionType>
class ExpressionArcTan : public ExpressionBase< ExpressionArcTan<BaseExpressionType> >
{
public:

    //! @name Public Types
    //@{

    // No direct use, just ease of coding
    typedef ExpressionBase< ExpressionArcTan <BaseExpressionType> > base_Type;

    //@}

    //! @name Constructors & Destructor
    //@{

    //! Full constructor using the two expressions
    ExpressionArcTan (const BaseExpressionType& l, const Real epsilon, const Real K, const Real delta)
        : base_Type(), M_l (l), M_epsilon (epsilon), M_K(K), M_delta(delta) {}

    //! Copy constructor
    ExpressionArcTan (const ExpressionArcTan<BaseExpressionType>& expression)
        :
        base_Type(),
        M_l (expression.M_l),
        M_epsilon (expression.M_epsilon),
        M_K (expression.M_K),
        M_delta (expression.M_delta)
    {}

    //! Destructor
    ~ExpressionArcTan() {}

    //@}


    //! @name Methods
    //@{

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

    //@}


    //! @name Private Methods
    //@{

    //! Getter for the left hand side
    const BaseExpressionType& base() const
    {
        return M_l;
    }

    //! Getter for the right hand side
    const Real& epsilon() const
    {
        return M_epsilon;
    }

    //! Getter for the right hand side
    const Real& K() const
    {
        return M_K;
    }

    //! Getter for the right hand side
    const Real& delta() const
    {
        return M_delta;
    }

    //@}

private:

    //! @name Private Methods
    //@{

    ExpressionArcTan();

    //@}


    // Left hand side
    BaseExpressionType M_l;

    Real M_epsilon;

    Real M_K;

    Real M_delta;

};


//! operator*  The generic operator for the product between expressions.
/*!
  @author Samuel Quinodoz <samuel.quinodoz@epfl.ch>

  Operator used in construction of the expression tree. To avoid shadowing
  other operator*, it uses the ExpressionBase type to distinguish expressions
  from other types.

  <b> Template parameters </b>

  <i>LExpressionType</i>: The expression on the left side of the product operation.

  <i>RExpressionType</i>: The expression on the right side of the product operation.

  <b> Template requirements </b>

  <i>LExpressionType</i>: Same as in LifeV::ExpressionProduct

  <i>RExpressionType</i>: Same as in LifeV::ExpressionProduct

  The expression that is built is:

  K * atan( \epsilon * ( ExpressionBase ) ) + delta

*/

template< typename  ExpressionType>
ExpressionArcTan<ExpressionType>
atan (const ExpressionBase<ExpressionType>& l, const Real& epsilon,
      const Real& K, const Real& delta)
{
    return ExpressionArcTan<ExpressionType> (l.cast(), epsilon, K, delta);
}


} // Namespace ExpressionAssembly

} // Namespace LifeV

#endif