timeIntegration.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2023 - 2025 NeoN authors
//
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <functional>
 
#include "NeoN/fields/field.hpp"
#include "NeoN/finiteVolume/cellCentred/fields/volumeField.hpp"
#include "NeoN/dsl/expression.hpp"
 
namespace NeoN::timeIntegration
{
 
/* @class Factory class to create time integration method by a given name
 * using NeoNs runTimeFactory mechanism
 */
template<typename SolutionType>
class TimeIntegratorBase :
    public RuntimeSelectionFactory<
        TimeIntegratorBase<SolutionType>,
        Parameters<const Dictionary&, const Dictionary&>>
{
 
public:
 
    using ValueType = typename SolutionType::VectorValueType;
    using Expression = NeoN::dsl::Expression<ValueType>;
 
    static std::string name() { return "timeIntegrationFactory"; }
 
    TimeIntegratorBase(const Dictionary& schemeDict, const Dictionary& solutionDict)
        : schemeDict_(schemeDict), solutionDict_(solutionDict)
    {}
 
    virtual ~TimeIntegratorBase() {}
 
    virtual void solve(
        Expression& eqn, SolutionType& sol, scalar t, scalar dt
    ) = 0; // Pure virtual function for solving
 
    // Pure virtual function for cloning
    virtual std::unique_ptr<TimeIntegratorBase> clone() const = 0;
 
    virtual bool explicitIntegration() const { return true; }
 
protected:
 
    const Dictionary& schemeDict_;
    const Dictionary& solutionDict_;
};
 
template<typename SolutionVectorType>
class TimeIntegration
{
 
public:
 
    using ValueType = typename SolutionVectorType::VectorValueType;
    using Expression = NeoN::dsl::Expression<ValueType>;
 
    TimeIntegration(const TimeIntegration& timeIntegrator)
        : timeIntegratorStrategy_(timeIntegrator.timeIntegratorStrategy_->clone()) {};
 
    TimeIntegration(TimeIntegration&& timeIntegrator)
        : timeIntegratorStrategy_(std::move(timeIntegrator.timeIntegratorStrategy_)) {};
 
    TimeIntegration(const Dictionary& schemeDict, const Dictionary& solutionDict)
        : timeIntegratorStrategy_(TimeIntegratorBase<SolutionVectorType>::create(
            schemeDict.get<std::string>("type"), schemeDict, solutionDict
        )) {};
 
    void solve(Expression& eqn, SolutionVectorType& sol, scalar t, scalar dt)
    {
        timeIntegratorStrategy_->solve(eqn, sol, t, dt);
    }
 
    bool explicitIntegration() const { return timeIntegratorStrategy_->explicitIntegration(); }
 
private:
 
    std::unique_ptr<TimeIntegratorBase<SolutionVectorType>> timeIntegratorStrategy_;
};
 
 
} // namespace NeoN::timeIntegration