assembly_options.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_assembly_options_hpp
#define bempp_assembly_options_hpp

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

#include "aca_options.hpp"

#include "../common/deprecated.hpp"
#include "../fiber/opencl_options.hpp"
#include "../fiber/parallelization_options.hpp"
#include "../fiber/verbosity_level.hpp"

namespace Bempp
{

using Fiber::OpenClOptions;
using Fiber::ParallelizationOptions;
using Fiber::VerbosityLevel;

class AssemblyOptions
{
public:
    enum Value { AUTO = -1, NO = 0, YES = 1 };

    AssemblyOptions();

    enum Mode {
        DENSE,
        ACA
    };

    void switchToDenseMode();

    void switchToAcaMode(const AcaOptions& acaOptions);

    BEMPP_DEPRECATED void switchToDense();

    BEMPP_DEPRECATED void switchToAca(const AcaOptions& acaOptions);

    Mode assemblyMode() const;

    const AcaOptions& acaOptions() const;

    // Temporarily removed (OpenCl support is broken).
    // void enableOpenCl(const OpenClOptions& openClOptions);
    // void disableOpenCl();

    void setMaxThreadCount(int maxThreadCount);

    BEMPP_DEPRECATED void switchToTbb(int maxThreadCount = AUTO);

    const ParallelizationOptions& parallelizationOptions() const;

    void setVerbosityLevel(VerbosityLevel::Level level);

    VerbosityLevel::Level verbosityLevel() const;

    void enableSingularIntegralCaching(bool value = true);

    bool isSingularIntegralCachingEnabled() const;

    void enableSparseStorageOfLocalOperators(bool value = true);

    bool isSparseStorageOfLocalOperatorsEnabled() const;

    void BEMPP_DEPRECATED enableSparseStorageOfMassMatrices(bool value = true);

    bool BEMPP_DEPRECATED isSparseStorageOfMassMatricesEnabled() const;

    void enableJointAssembly(bool value = true);

    bool isJointAssemblyEnabled() const;

    void enableBlasInQuadrature(Value value = AUTO);

    Value isBlasEnabledInQuadrature() const;

    void makeQuadratureOrderUniformInEachCluster(bool value = true);

    bool isQuadratureOrderUniformInEachCluster() const;

private:
    Mode m_assemblyMode;
    AcaOptions m_acaOptions;
    ParallelizationOptions m_parallelizationOptions;
    VerbosityLevel::Level m_verbosityLevel;
    bool m_singularIntegralCaching;
    bool m_sparseStorageOfLocalOperators;
    bool m_jointAssembly;
    bool m_uniformQuadrature;
    Value m_blasInQuadrature;
};

} // namespace Bempp

#endif