scale_add_linker.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program 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.
 */
 
#ifndef __H__UG__LIB_DISC__SPATIAL_DISC__SCALE_ADD_LINKER__
#define __H__UG__LIB_DISC__SPATIAL_DISC__SCALE_ADD_LINKER__
 
#include "linker.h"
 
namespace ug{
 
 
// Scaled adding of Data
 
template <typename TData, int dim, typename TDataScale, typename TRet = TData>
class ScaleAddLinker
  : public StdDataLinker<ScaleAddLinker<TData, dim, TDataScale, TRet>, TRet, dim>
{
  public:
  //  type of base class
    typedef StdDataLinker<ScaleAddLinker<TData, dim, TDataScale, TRet>, TRet, dim> base_type;
 
  public:
    ScaleAddLinker() {}
 
    ScaleAddLinker(const ScaleAddLinker& linker);
 
    void add(SmartPtr<CplUserData<TDataScale, dim> > scale,
             SmartPtr<CplUserData<TData, dim> > data);
    void add(number scale,
             SmartPtr<CplUserData<TData, dim> > data);
    void add(SmartPtr<CplUserData<TDataScale, dim> > scale,
             number data);
    void add(number scale,
             number data);
 
    inline void evaluate (TRet& value,
                          const MathVector<dim>& globIP,
                          number time, int si) const;
 
    template <int refDim>
    inline void evaluate(TRet vValue[],
                         const MathVector<dim> vGlobIP[],
                         number time, int si,
                         GridObject* elem,
                         const MathVector<dim> vCornerCoords[],
                         const MathVector<refDim> vLocIP[],
                         const size_t nip,
                         LocalVector* u,
                         const MathMatrix<refDim, dim>* vJT = NULL) const;
 
    template <int refDim>
    void eval_and_deriv(TRet vValue[],
                        const MathVector<dim> vGlobIP[],
                        number time, int si,
                        GridObject* elem,
                        const MathVector<dim> vCornerCoords[],
                        const MathVector<refDim> vLocIP[],
                        const size_t nip,
                        LocalVector* u,
                        bool bDeriv,
                        int s,
                        std::vector<std::vector<TRet> > vvvDeriv[],
                        const MathMatrix<refDim, dim>* vJT = NULL) const;
 
  protected:
    const TData& input_value(size_t i, size_t s, size_t ip) const
    {
      UG_ASSERT(i < m_vpUserData.size(), "Input not needed");
      UG_ASSERT(m_vpUserData[i].valid(), "Input invalid");
      return m_vpUserData[i]->value(this->series_id(2*i,s), ip);
    }
 
    const TData& input_deriv(size_t i, size_t s, size_t ip, size_t fct, size_t dof) const
    {
      UG_ASSERT(i < m_vpDependData.size(), "Input not needed");
      UG_ASSERT(m_vpDependData[i].valid(), "Input invalid");
      return m_vpDependData[i]->deriv(this->series_id(2*i,s), ip, fct, dof);
    }
 
    const TDataScale& scale_value(size_t i, size_t s, size_t ip) const
    {
      UG_ASSERT(i < m_vpScaleData.size(), "Input not needed");
      UG_ASSERT(m_vpScaleData[i].valid(), "Input invalid");
      return m_vpScaleData[i]->value(this->series_id(2*i+1,s), ip);
    }
 
    const TDataScale& scale_deriv(size_t i, size_t s, size_t ip, size_t fct, size_t dof) const
    {
      UG_ASSERT(i < m_vpScaleDependData.size(), "Input not needed");
      UG_ASSERT(m_vpScaleDependData[i].valid(), "Input invalid");
      return m_vpScaleDependData[i]->deriv(this->series_id(2*i+1,s), ip, fct, dof);
    }
 
    size_t input_num_fct(size_t i) const {return base_type::input_num_fct(2*i);}
 
    size_t input_common_fct(size_t i, size_t fct) const {return base_type::input_common_fct(2*i, fct);}
 
    size_t scale_num_fct(size_t i) const {return base_type::input_num_fct(2*i+1);}
 
    size_t scale_common_fct(size_t i, size_t fct) const {return base_type::input_common_fct(2*i+1, fct);}
 
  protected:
    std::vector<SmartPtr<CplUserData<TDataScale, dim> > > m_vpScaleData;
 
    std::vector<SmartPtr<DependentUserData<TDataScale, dim> > > m_vpScaleDependData;
 
    std::vector<SmartPtr<CplUserData<TData, dim> > > m_vpUserData;
 
    std::vector<SmartPtr<DependentUserData<TData, dim> > > m_vpDependData;
};
 
} // end namespace ug
 
#include "scale_add_linker_impl.h"
 
#endif /* __H__UG__LIB_DISC__SPATIAL_DISC__SCALE_ADD_LINKER__ */