Field.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS 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 General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "common/CepsCommon.hpp"
#include "geometry/selectors/AbstractSelector.hpp"
#include "pde/common/functions/SAFunc.hpp"
#include "pde/common/DegreeOfFreedom.hpp"
 
// Forwrad declaration
template <class _Result, class _SupportType>
class Field;
 
template <class _SupportType>
using ScalarField = Field<CepsMathScalar,_SupportType>;
template <class _SupportType>
using VectorField = Field<CepsMathVertex,_SupportType>;
template <class _SupportType>
using TensorField = Field<CepsMathTensor,_SupportType>;
 
template <class _Result, class _SupportType>
class Field
{
 
  public:
 
    using FunctionType = SAFunc<_Result>;
    using _Domain      = CepsVector<_SupportType*>;
    using _Iterator    = typename CepsVector<_SupportType*>::const_iterator;
  
    Field(
      FunctionType*   functor, 
      const _Domain*  domain, 
      CepsBool        bufferize = false
    );
 
    virtual ~Field() = default;
 
    void 
    addDomain(const _Domain* domain);
 
    void 
    clearDomains();
 
    FunctionType*
    getFunctor() const;
 
    void
    setFunctor(ceps::Function<_Result(CepsStandardArgs)>* functor);
 
    void
    setScaleFactor(CepsReal scaleFactor);
 
    CepsReal
    getScaleFactor() const;
 
    CepsBool
    isBuffered() const;
 
    CepsBool
    hasBufferedData() const;
 
    CepsEnum
    getFunctorFlags() const;
 
    CepsBool
    hasFunctorOption(CepsFunctionFlag flag) const;
 
    CepsBool
    isSpaceVariable() const;
 
    CepsBool
    isTimeVariable() const;
 
    CepsBool
    needsSolution() const;
 
    void
    getValues(
      CepsVector<_Result>&             values, 
      CepsReal                         t,
      const CepsVector<_SupportType*>& points={}
    );
 
    _Result
    getValue(_SupportType* point, CepsReal t);
 
    void
    computeSupport(AbstractSelector<_Iterator>* selector,CepsBool canStartEmpty=false);
 
    virtual void
    actualize(CepsReal t);
 
    CepsVector<_Result>& 
    getBufferedData();
 
    CepsVector<CepsGlobalIndex>& 
    getSupportIndices();
 
    const CepsVector<_SupportType*>& 
    getSupport();
 
    const CepsVector<const CepsVector<_SupportType*>*>&
    getDomains();
 
    friend class BoundaryConditionManager;
    friend class SourceTermManager;
 
  protected:
 
    virtual void
    evaluateAll(CepsReal t, CepsVector<_Result>& results);
 
    virtual void
    evaluateOn(const _Domain* domain, CepsReal t, CepsUInt offset, CepsVector<_Result>& results);
 
    FunctionType*               m_functor;        
    CepsReal                    m_scaleFactor;    
    CepsVector<_SupportType*>   m_support;        
    CepsVector<CepsGlobalIndex> m_supportIndices; 
    CepsBool                    m_supportComputed;
    CepsVector<_Result>         m_buffer;         
    CepsBool                    m_precompute;     
    CepsBool                    m_isPrecomputed;  
 
    CepsVector<const CepsVector<_SupportType*>*> m_domains; 
  
};
 
// Interactions with distributed vectors, exclusive to Scalar Fields
 
template<class _SupportType>
void
addFieldValuesTo(ScalarField<_SupportType>& f, DistributedVector* vec,
                 CepsReal t=0.);
 
template<class _SupportType>
void
setFieldValuesTo(ScalarField<_SupportType>& f, DistributedVector* vec,
                 CepsReal t=0.);
 
template<class _SupportType>
void
scaleByField(DistributedVector* vec, ScalarField<_SupportType>& f, 
             CepsReal           t   = 0.,
             CepsBool           divide = false);
 
template<class _SupportType>
void
scaleByField(
  DistributedVector*            vec,
  ScalarField<_SupportType>&    f,
  const CepsSet<CepsAttribute>& attrs,
  const CepsSet<Unknown*>       unknowns,
  CepsReal                      t = 0.,
  CepsBool                      divide = false
);
 
template<class _SupportType>
void
scaleByField(
  DistributedVector*                      vec,
  ScalarField<_SupportType>&              f,
  std::function<CepsBool(_SupportType*)>* predicate,
  CepsReal                                t = 0.,
  CepsBool                                divide = false
);
 
template<class _SupportType>
void
scaleByFieldInternal(
  DistributedVector*                      vec,
  ScalarField<_SupportType>&              f,
  std::function<CepsBool(_SupportType*)>* predicate,
  CepsReal                                t,
  CepsBool                                divide,
  const CepsVector<_SupportType*>*        domain,
  CepsUInt                                offset = 0
);
 
// Definitions of these last template functions
#include "pde/common/functions/Field.tpp"