Python/TimeIntegration/TimeIntegrationScheme.cpp

Go to the documentation of this file.

//////////////////////////////////////////////////////////////////////////////
//
// File: TimeIntegrationScheme.cpp
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
// Department of Aeronautics, Imperial College London (UK), and Scientific
// Computing and Imaging Institute, University of Utah (USA).
//
// 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.
//
// Description: Python wrapper for TimeIntegrationScheme.
//
///////////////////////////////////////////////////////////////////////////////
 
#include <LibUtilities/Python/NekPyConfig.hpp>
 
#include <LibUtilities/TimeIntegration/TimeIntegrationScheme.h>
 
using namespace Nektar;
using namespace Nektar::LibUtilities;
 
/// This is required since TimeIntegrationScheme has a protected destructror:
/// actually not quite sure why this is the case!
class TIS_Deletable : public TimeIntegrationScheme
{
public:
    ~TIS_Deletable() override = default;
};
 
void export_TimeIntegrationScheme(py::module &m)
{
    // Very lightweight class around the time-integration scheme. Mostly this is
    // here for debugging purposes rather than to provide a full wrapper around
    // this class.
    py::class_<TIS_Deletable, std::shared_ptr<TIS_Deletable>>(
        m, "TimeIntegrationScheme")
        .def("GetFullName", &TimeIntegrationScheme::GetFullName)
        .def("GetName", &TimeIntegrationScheme::GetName)
        .def("GetVariant", &TimeIntegrationScheme::GetVariant)
        .def("GetOrder", &TimeIntegrationScheme::GetOrder)
 
        .def("GetTimeStability", &TimeIntegrationScheme::GetTimeStability)
        .def("GetNumIntegrationPhases",
             &TimeIntegrationScheme::GetNumIntegrationPhases);
}