OperationSmallAddition.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 information about the addition operation between *Small classes.

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

#ifndef OPERATION_SMALL_ADDITION_HPP
#define OPERATION_SMALL_ADDITION_HPP

#include <lifev/core/LifeV.hpp>

#include <lifev/core/array/VectorSmall.hpp>


namespace LifeV
{
//! class OperationSmallAddition  Class containing information about the addition operation between the *Small classes.

/*!
  @author Samuel Quinodoz <samuel.quinodoz@epfl.ch>

  This class only contains information that can be usefull in a templated framework (such as the
  one for assembling the algebraic systems via expressions).

  It cannot be instanciated, neither the generic definition nor the specializations (private constructors
  and destructor only).

  The only information stored in this class is the type of the result. For example, as the addition
  of a LifeV::Real with a LifeV::Real is a LifeV::Real as well, the specialization
  LifeV::OperationSmallAddition<LifeV::Real,LifeV::Real> contains the typedef result_Type that aliases
  the LifeV::Real type.

*/
template <typename LeftOperand, typename RightOperand>
class OperationSmallAddition
{
private:
    //! @name Constructors and destructors
    //@{

    //! No default constructor
    OperationSmallAddition();

    //! No destructor
    ~OperationSmallAddition();

    //@}
};

//! \cond

template <>
class OperationSmallAddition<Real, Real>
{
public:

    //! @name Public Types
    //@{

    typedef Real result_Type;

    //@}

private:
    //! @name Constructors and destructors
    //@{

    //! No default constructor
    OperationSmallAddition();

    //! No destructor
    ~OperationSmallAddition();

    //@}
};


template <UInt Size>
class OperationSmallAddition< VectorSmall<Size> , VectorSmall<Size> >
{
public:

    //! @name Public Types
    //@{

    typedef VectorSmall<Size> result_Type;

    //@}

private:
    //! @name Constructors and destructors
    //@{

    //! No default constructor
    OperationSmallAddition();

    //! No destructor
    ~OperationSmallAddition();

    //@}
};

// specialization for matrix + matrix
template <UInt Dim1, UInt Dim2>
class OperationSmallAddition< MatrixSmall<Dim1, Dim2> , MatrixSmall<Dim1, Dim2> >
{
public:

    //! @name Public Types
    //@{

    typedef MatrixSmall<Dim1, Dim2> result_Type;

    //@}

private:
    //! @name Constructors and destructors
    //@{

    //! No default constructor
    OperationSmallAddition();

    //! No destructor
    ~OperationSmallAddition();

    //@}
};

//! \endcond

} // namespace LifeV


#endif