EvaluationVectorFromNonConstantScalar.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 EvaluationTranspose class.

     @date 08/2012
     @author Samuel Quinodoz <samuel.quinodoz@epfl.ch>
 */

#ifndef EVALUTATION_VECTORFROMNONCONSTANTSCALAR_HPP
#define EVALUTATION_VECTORFROMNONCONSTANTSCALAR_HPP


#include <lifev/core/LifeV.hpp>

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

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

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

namespace LifeV
{

namespace ExpressionAssembly
{

//! Evaluation for the transpose of another Evaluation
/*!
  @author Samuel Quinodoz <samuel.quinodoz@epfl.ch>

  This class aims at representing the transpose 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 EvaluationType, UInt FieldDim>
class EvaluationVectorFromNonConstantScalar
{
public:


    //! @name Public Types
    //@{

    //! Type of the value returned by the 'operand' to be transposed
    //  typedef typename EvaluationType::return_Type return_Type;

    //! Type of the value returned by this class
    // NOTE: specialized for 3d problems
    typedef VectorSmall<FieldDim> 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
    EvaluationVectorFromNonConstantScalar (const EvaluationVectorFromNonConstantScalar& eval)
        : M_evaluation (eval.M_evaluation)
    {}

    //! Constructor from the corresponding expression
    template< typename Expression>
    explicit EvaluationVectorFromNonConstantScalar (const ExpressionVectorFromNonConstantScalar<Expression, FieldDim>& expression)
        : M_evaluation (expression.exprEx() )
    {}

    //! Destructor
    ~EvaluationVectorFromNonConstantScalar()
    {}

    //@}


    //! @name Methods
    //@{

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

    //! Display method
    static void display (std::ostream& out = std::cout)
    {
        out << " vector from scalar expression ";
        EvaluationType::display (out);
    }

    //@}


    //! @name Set Methods
    //@{

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

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

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

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

    //@}


    //! @name Get Methods
    //@{

    //! Getter for a value
    return_Type value_q (const UInt& q) const
    {
        return VectorSmall<FieldDim> ( M_evaluation.value_q( q ) );
    }

    //! Getter for the value for a vector
    return_Type value_qi (const UInt& q, const UInt& i) const
    {
        return VectorSmall<FieldDim> ( M_evaluation.value_qi( q,i ) );
    }

    //! Getter for the value for a matrix
    return_Type value_qij (const UInt& q, const UInt& i, const UInt& j) const
    {
      return VectorSmall<FieldDim> ( M_evaluation.value_qij( q,i,j ) );
    }

    //@}

private:

    //! @name Private Methods
    //@{

    //! No default
    EvaluationVectorFromNonConstantScalar();

    //@}

    // Internal storage
    EvaluationType M_evaluation;
};


template< typename EvaluationType, UInt FieldDim >
const flag_Type EvaluationVectorFromNonConstantScalar<EvaluationType, FieldDim>::S_globalUpdateFlag
    = EvaluationType::S_globalUpdateFlag;

template< typename EvaluationType, UInt FieldDim >
const flag_Type EvaluationVectorFromNonConstantScalar<EvaluationType, FieldDim>::S_testUpdateFlag
    = EvaluationType::S_testUpdateFlag;

template< typename EvaluationType, UInt FieldDim >
const flag_Type EvaluationVectorFromNonConstantScalar<EvaluationType, FieldDim>::S_solutionUpdateFlag
    = EvaluationType::S_solutionUpdateFlag;

} // Namespace ExpressionAssembly

} // Namespace LifeV
#endif