Nektar++
FilterPython.h
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: FilterPython.h
4//
5// For more information, please see: http://www.nektar.info
6//
7// The MIT License
8//
9// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10// Department of Aeronautics, Imperial College London (UK), and Scientific
11// Computing and Imaging Institute, University of Utah (USA).
12//
13// Permission is hereby granted, free of charge, to any person obtaining a
14// copy of this software and associated documentation files (the "Software"),
15// to deal in the Software without restriction, including without limitation
16// the rights to use, copy, modify, merge, publish, distribute, sublicense,
17// and/or sell copies of the Software, and to permit persons to whom the
18// Software is furnished to do so, subject to the following conditions:
19//
20// The above copyright notice and this permission notice shall be included
21// in all copies or substantial portions of the Software.
22//
23// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29// DEALINGS IN THE SOFTWARE.
30//
31// Description: Run a Python script during runtime through Filters.
32//
33///////////////////////////////////////////////////////////////////////////////
34
35#ifndef NEKTAR_SOLVERUTILS_FILTERS_FILTERPYTHON_H
36#define NEKTAR_SOLVERUTILS_FILTERS_FILTERPYTHON_H
37
40
41#include <pybind11/embed.h>
42
43namespace Nektar::SolverUtils
44{
45
46#pragma GCC visibility push(hidden)
47class FilterPython : public Filter
48{
49public:
50 friend class MemoryManager<FilterPython>;
51
52 /// Creates an instance of this class
55 const std::shared_ptr<EquationSystem> &pEquation,
56 const std::map<std::string, std::string> &pParams)
57 {
59 pSession, pEquation, pParams);
60 return p;
61 }
62
63 /// Name of the class
64 static std::string className;
65
68 const std::shared_ptr<EquationSystem> &pEquation,
69 const ParamMap &pParams);
71
72protected:
73 void v_Initialise(
75 const NekDouble &time) override;
76 void v_Update(
78 const NekDouble &time) override;
79 void v_Finalise(
81 const NekDouble &time) override;
82 bool v_IsTimeDependent() override;
83
84private:
85 /// Container for Python global variables.
86 py::object m_global;
87 /// Python filter class to run (optionally)
88 std::shared_ptr<Filter> m_pyFilter = nullptr;
89};
90#pragma GCC visibility pop
91
92} // namespace Nektar::SolverUtils
93
94#endif
#define SOLVER_UTILS_EXPORT
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
std::map< std::string, std::string > ParamMap
Definition: Filter.h:66
py::object m_global
Container for Python global variables.
Definition: FilterPython.h:86
void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
std::shared_ptr< Filter > m_pyFilter
Python filter class to run (optionally)
Definition: FilterPython.h:88
SOLVER_UTILS_EXPORT ~FilterPython() override
void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
SOLVER_UTILS_EXPORT FilterPython(const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< EquationSystem > &pEquation, const ParamMap &pParams)
static FilterSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< EquationSystem > &pEquation, const std::map< std::string, std::string > &pParams)
Creates an instance of this class.
Definition: FilterPython.h:53
static std::string className
Name of the class.
Definition: FilterPython.h:64
void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
std::shared_ptr< SessionReader > SessionReaderSharedPtr
std::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:52
double NekDouble