BasisOperations.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2021.                                                        *
 * The Regents of the University of Michigan and DFT-EFE developers.          *
 *                                                                            *
 * This file is part of the DFT-EFE code.                                     *
 *                                                                            *
 * DFT-EFE is free software: you can redistribute it and/or modify            *
 *   it under the terms of the Lesser GNU General Public License as           *
 *   published by the Free Software Foundation, either version 3 of           *
 *   the License, or (at your option) any later version.                      *
 *                                                                            *
 * DFT-EFE is distributed in the hope that it will be useful, but             *
 *   WITHOUT ANY WARRANTY; without even the implied warranty                  *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     *
 *   See the Lesser GNU General Public License for more details.              *
 *                                                                            *
 * You should have received a copy of the GNU Lesser General Public           *
 *   License at the top level of DFT-EFE distribution.  If not, see           *
 *   <https://www.gnu.org/licenses/>.                                         *
 ******************************************************************************/
 
/*
 * @author Bikash Kanungo, Vishal Subramanian
 */
 
#ifndef dftefeBasisOperations_h
#define dftefeBasisOperations_h
 
#include <utils/TypeConfig.h>
#include <utils/MemorySpaceType.h>
#include <utils/ScalarSpatialFunction.h>
#include <quadrature/QuadratureAttributes.h>
#include <quadrature/QuadratureValuesContainer.h>
#include <linearAlgebra/BlasLapackTypedef.h>
#include <linearAlgebra/MultiVector.h>
namespace dftefe
{
  namespace basis
  {
    namespace realspace
    {
      enum class VectorMathOp
      {
        DOT,
        CROSS,
        MULT,
        ADD
      };
 
      enum class LinearLocalOp
      {
        IDENTITY,
        GRAD,
        LAPLACIAN,
        CURL
      };
    } // end of namespace realspace
    template <typename ValueTypeBasisCoeff,
              typename ValueTypeBasisData,
              utils::MemorySpace memorySpace>
    class BasisOperations
    {
    public:
      using ValueTypeUnion =
        linearAlgebra::blasLapack::scalar_type<ValueTypeBasisCoeff,
                                               ValueTypeBasisData>;
 
      using StorageBasis =
        dftefe::utils::MemoryStorage<ValueTypeBasisData, memorySpace>;
 
      using StorageUnion =
        dftefe::utils::MemoryStorage<ValueTypeUnion, memorySpace>;
 
    public:
      virtual ~BasisOperations() = default;
 
      // virtual void
      // integrateWithBasisValues(const
      // ScalarSpatialFunction<ValueTypeBasisCoeff> &f,
      //    const quadrature::QuadratureRuleAttributes &
      //    quadratureRuleAttributes,
      //                         Field<ValueTypeBasisCoeff, memorySpace> &
      //                         field) const = 0;
 
      virtual void
      interpolate(const Field<ValueTypeBasisCoeff, memorySpace> &field,
                  quadrature::QuadratureValuesContainer<
                    linearAlgebra::blasLapack::scalar_type<ValueTypeBasisCoeff,
                                                           ValueTypeBasisData>,
                    memorySpace> &quadValuesContainer) const = 0;
 
      virtual void
      interpolate(
        const linearAlgebra::MultiVector<ValueTypeBasisCoeff, memorySpace>
          &                                                   vectorData,
        const BasisManager<ValueTypeBasisCoeff, memorySpace> &basisManager,
        quadrature::QuadratureValuesContainer<
          linearAlgebra::blasLapack::scalar_type<ValueTypeBasisCoeff,
                                                 ValueTypeBasisData>,
          memorySpace> &quadValuesContainer) const = 0;
 
      virtual void
      interpolateWithBasisGradient(
        const linearAlgebra::MultiVector<ValueTypeBasisCoeff, memorySpace>
          &                                                   vectorData,
        const BasisManager<ValueTypeBasisCoeff, memorySpace> &basisManager,
        quadrature::QuadratureValuesContainer<
          linearAlgebra::blasLapack::scalar_type<ValueTypeBasisCoeff,
                                                 ValueTypeBasisData>,
          memorySpace> &quadValuesContainer) const = 0;
 
 
      virtual void
      integrateWithBasisValues(
        const quadrature::QuadratureValuesContainer<
          linearAlgebra::blasLapack::scalar_type<ValueTypeBasisCoeff,
                                                 ValueTypeBasisData>,
          memorySpace> &                         inp,
        Field<ValueTypeBasisCoeff, memorySpace> &f) const = 0;
 
      virtual void
      integrateWithBasisValues(
        const quadrature::QuadratureValuesContainer<
          linearAlgebra::blasLapack::scalar_type<ValueTypeBasisCoeff,
                                                 ValueTypeBasisData>,
          memorySpace> &                                      inp,
        const BasisManager<ValueTypeBasisCoeff, memorySpace> &basisManager,
        linearAlgebra::MultiVector<ValueTypeBasisCoeff, memorySpace>
          &vectorData) const = 0;
      // virtual void
      // integrateWithBasisValues(
      //  const Field<ValueTypeBasisCoeff, memorySpace> &       fieldInput,
      //  const quadrature::QuadratureRuleAttributes &quadratureRuleAttributes,
      //  Field<ValueTypeBasisCoeff, memorySpace> &             fieldOutput)
      //  const = 0;
 
    }; // end of BasisOperations
  }    // end of namespace basis
} // end of namespace dftefe
#endif // dftefeBasisOperations_h