grid_function.hpp

// Copyright (C) 2011-2012 by the BEM++ Authors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.


#ifndef bempp_grid_function_hpp
#define bempp_grid_function_hpp

#include "../common/common.hpp"

#include "../common/armadillo_fwd.hpp"
#include "../common/deprecated.hpp"
#include "../common/shared_ptr.hpp"

#include "../grid/vtk_writer.hpp"
#include "../fiber/quadrature_strategy.hpp"
#include "../fiber/scalar_traits.hpp"

#include <boost/mpl/set.hpp>
#include <boost/mpl/has_key.hpp>
#include <boost/utility/enable_if.hpp>
#include <memory>

namespace Fiber
{

template <typename ValueType> class Basis;
template <typename ResultType> class LocalAssemblerForGridFunctions;
template <typename ValueType> class Function;
} // namespace Fiber

namespace Bempp
{

class AssemblyOptions;
class GeometryFactory;
class Grid;
template <int codim> class Entity;
template <typename BasisFunctionType> class Space;
template <typename BasisFunctionType, typename ResultType> class Context;
using Fiber::Function;

template <typename BasisFunctionType, typename ResultType>
class GridFunction
{
public:
    typedef typename Fiber::ScalarTraits<ResultType>::RealType CoordinateType;
    typedef typename Fiber::ScalarTraits<ResultType>::RealType MagnitudeType;

    enum DataType { COEFFICIENTS, PROJECTIONS };
    enum ConstructionMode { APPROXIMATE, INTERPOLATE };

    // Recommended constructors

    GridFunction();

    GridFunction(const shared_ptr<const Context<BasisFunctionType, ResultType> >& context,
                 const shared_ptr<const Space<BasisFunctionType> >& space,
                 const arma::Col<ResultType>& coefficients);

    GridFunction(const shared_ptr<const Context<BasisFunctionType, ResultType> >& context,
                 const shared_ptr<const Space<BasisFunctionType> >& space,
                 const shared_ptr<const Space<BasisFunctionType> >& dualSpace,
                 const arma::Col<ResultType>& projections);

    GridFunction(const shared_ptr<const Context<BasisFunctionType, ResultType> >& context,
                 const shared_ptr<const Space<BasisFunctionType> >& space,
                 const shared_ptr<const Space<BasisFunctionType> >& dualSpace,
                 const Function<ResultType>& function,
                 ConstructionMode mode = APPROXIMATE);

    // Deprecated constructors

    BEMPP_DEPRECATED
    GridFunction(const shared_ptr<const Context<BasisFunctionType, ResultType> >& context,
                 const shared_ptr<const Space<BasisFunctionType> >& space,
                 const shared_ptr<const Space<BasisFunctionType> >& dualSpace,
                 const arma::Col<ResultType>& data,
                 DataType dataType);

    BEMPP_DEPRECATED
    GridFunction(const shared_ptr<const Context<BasisFunctionType, ResultType> >& context,
                 const shared_ptr<const Space<BasisFunctionType> >& space,
                 const shared_ptr<const Space<BasisFunctionType> >& dualSpace,
                 const arma::Col<ResultType>& coefficients,
                 const arma::Col<ResultType>& projections);

    // Member functions

    bool isInitialized() const;

    bool wasInitializedFromCoefficients() const;

    shared_ptr<const Grid> grid() const;

    shared_ptr<const Space<BasisFunctionType> > space() const;

    shared_ptr<const Space<BasisFunctionType> > dualSpace() const;

    shared_ptr<const Context<BasisFunctionType, ResultType> > context() const;

    int componentCount() const;

    const arma::Col<ResultType>& coefficients() const;

    arma::Col<ResultType> projections(
            const shared_ptr<const Space<BasisFunctionType> >& dualSpace_) const;

    void setCoefficients(const arma::Col<ResultType>& coeffs);

    void setProjections(
            const shared_ptr<const Space<BasisFunctionType> >& dualSpace_,
            const arma::Col<ResultType>& projects);

    MagnitudeType L2Norm() const;

    const Fiber::Shapeset<BasisFunctionType>& shapeset(const Entity<0>& element) const;

    const BEMPP_DEPRECATED Fiber::Basis<BasisFunctionType>& basis(const Entity<0>& element) const;

    void getLocalCoefficients(const Entity<0>& element,
                              std::vector<ResultType>& coeffs) const;

    void evaluateAtSpecialPoints(
            VtkWriter::DataType dataType, arma::Mat<ResultType>& result_) const;
    void evaluateAtSpecialPoints(
            VtkWriter::DataType dataType,
            arma::Mat<CoordinateType>& points, arma::Mat<ResultType>& values) const;

    void evaluate(
        const Entity<0>& element,
        const arma::Mat<CoordinateType>& local,
        arma::Mat<ResultType>& values) const;

    // Deprecated functions

#ifndef SWIG

    BEMPP_DEPRECATED arma::Col<ResultType> projections(
            const Space<BasisFunctionType>& dualSpace_) const;
#endif

    BEMPP_DEPRECATED arma::Col<ResultType> projections() const;

#ifndef SWIG

    BEMPP_DEPRECATED void setProjections(
            const Space<BasisFunctionType>& dualSpace_,
            const arma::Col<ResultType>& projects);
#endif

    BEMPP_DEPRECATED void setProjections(const arma::Col<ResultType>& projects);

    BEMPP_DEPRECATED
    void exportToVtk(VtkWriter::DataType dataType,
                     const char* dataLabel,
                     const char* fileNamesBase, const char* filesPath = 0,
                     VtkWriter::OutputType type = VtkWriter::ASCII) const;

    BEMPP_DEPRECATED
    void exportToGmsh(
        const char* dataLabel, const char* fileName) const;

private:
    void initializeFromCoefficients(
            const shared_ptr<const Context<BasisFunctionType, ResultType> >& context,
            const shared_ptr<const Space<BasisFunctionType> >& space,
            const arma::Col<ResultType>& coefficients);
    void initializeFromProjections(
            const shared_ptr<const Context<BasisFunctionType, ResultType> >& context,
            const shared_ptr<const Space<BasisFunctionType> >& space,
            const shared_ptr<const Space<BasisFunctionType> >& dualSpace,
            const arma::Col<ResultType>& projections);
    void updateProjectionsFromCoefficients(
            const shared_ptr<const Space<BasisFunctionType> >& dualSpace_) const;
    void updateCoefficientsFromProjections() const;

private:
    shared_ptr<const Context<BasisFunctionType, ResultType> > m_context;
    shared_ptr<const Space<BasisFunctionType> > m_space;
    mutable shared_ptr<const Space<BasisFunctionType> > m_dualSpace; // the dual space that was used to calculate m_projections
    mutable shared_ptr<const arma::Col<ResultType> > m_coefficients;
    mutable shared_ptr<const arma::Col<ResultType> > m_projections;
    bool m_wasInitializedFromCoefficients;
};

// Overloaded operators

template <typename BasisFunctionType, typename ResultType>
GridFunction<BasisFunctionType, ResultType> operator+(
        const GridFunction<BasisFunctionType, ResultType>& g);

template <typename BasisFunctionType, typename ResultType>
GridFunction<BasisFunctionType, ResultType> operator-(
        const GridFunction<BasisFunctionType, ResultType>& g);

template <typename BasisFunctionType, typename ResultType>
GridFunction<BasisFunctionType, ResultType> operator+(
        const GridFunction<BasisFunctionType, ResultType>& g1,
        const GridFunction<BasisFunctionType, ResultType>& g2);

template <typename BasisFunctionType, typename ResultType>
GridFunction<BasisFunctionType, ResultType> operator-(
        const GridFunction<BasisFunctionType, ResultType>& g1,
        const GridFunction<BasisFunctionType, ResultType>& g2);

template <typename BasisFunctionType, typename ResultType, typename ScalarType>
GridFunction<BasisFunctionType, ResultType> operator*(
        const GridFunction<BasisFunctionType, ResultType>& g, const ScalarType& scalar);

// This type machinery is needed to disambiguate between this operator and
// the one taking a AbstractBoundaryOperator and a GridFunction
template <typename BasisFunctionType, typename ResultType, typename ScalarType>
typename boost::enable_if<
    typename boost::mpl::has_key<
        boost::mpl::set<float, double, std::complex<float>, std::complex<double> >,
        ScalarType>,
    GridFunction<BasisFunctionType, ResultType> >::type
operator*(
        const ScalarType& scalar, const GridFunction<BasisFunctionType, ResultType>& g);

template <typename BasisFunctionType, typename ResultType, typename ScalarType>
GridFunction<BasisFunctionType, ResultType> operator/(
        const GridFunction<BasisFunctionType, ResultType>& g1, const ScalarType& scalar);

// Export

template <typename BasisFunctionType, typename ResultType>
void exportToVtk(const GridFunction<BasisFunctionType, ResultType>& gridFunction,
                 VtkWriter::DataType dataType,
                 const char* dataLabel,
                 const char* fileNamesBase, const char* filesPath = 0,
                 VtkWriter::OutputType type = VtkWriter::ASCII);

template <typename BasisFunctionType, typename ResultType>
void exportToGmsh(const GridFunction<BasisFunctionType, ResultType>& gridFunction,
                  const char* dataLabel, const char* fileName);

} // namespace Bempp

#endif