Nektar::SolverUtils::FilterPython Class Reference

#include <FilterPython.h>

Inheritance diagram for Nektar::SolverUtils::FilterPython:

Public Member Functions
SOLVER_UTILS_EXPORT	FilterPython (const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< EquationSystem > &pEquation, const ParamMap &pParams)
SOLVER_UTILS_EXPORT	~FilterPython () override
Public Member Functions inherited from Nektar::SolverUtils::Filter
SOLVER_UTILS_EXPORT	Filter (const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< EquationSystem > &pEquation)
virtual SOLVER_UTILS_EXPORT	~Filter ()
SOLVER_UTILS_EXPORT void	Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
SOLVER_UTILS_EXPORT void	Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
SOLVER_UTILS_EXPORT void	Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
SOLVER_UTILS_EXPORT bool	IsTimeDependent ()

Static Public Member Functions
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. More...

Static Public Attributes
static std::string	className
	Name of the class. More...

Protected Member Functions
void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
bool	v_IsTimeDependent () override
virtual void	v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual void	v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual void	v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual bool	v_IsTimeDependent ()=0

Private Attributes
LibUtilities::FieldIOSharedPtr	m_fld
py::object	m_global
std::shared_ptr< Filter >	m_pyFilter = nullptr

Friends
class	MemoryManager< FilterPython >

Additional Inherited Members
Public Types inherited from Nektar::SolverUtils::Filter
typedef std::map< std::string, std::string >	ParamMap
Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr	m_session
const std::weak_ptr< EquationSystem >	m_equ

Detailed Description

Definition at line 43 of file FilterPython.h.

Constructor & Destructor Documentation

FilterPython()

Nektar::SolverUtils::FilterPython::FilterPython	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const std::shared_ptr< EquationSystem > &	pEquation,
		const ParamMap &	pParams
	)

Definition at line 139 of file FilterPython.cpp.

    : Filter(pSession, pEquation)
{
    auto it = pParams.find("PythonFile");
    ASSERTL0(it != pParams.end(), "Empty parameter 'PythonFile'.");
    std::string pythonFile = it->second;
 
    Py_Initialize();
    std::string pythonCode;
 
    // Set the global namespace.
    m_global = py::import("__main__").attr("__dict__");
 
    try
    {
        std::ifstream t(pythonFile);
        std::string str((std::istreambuf_iterator<char>(t)),
                        std::istreambuf_iterator<char>());
        pythonCode = str;
    }
    catch (...)
    {
        ASSERTL0(false, "Error reading Python file: " + pythonFile);
    }
 
    // Print out the loaded session file if we're running in verbose mode.
    if (pSession->DefinesCmdLineArgument("verbose"))
    {
        std::cout << "-----------------" << std::endl;
        std::cout << "BEGIN PYTHON CODE" << std::endl;
        std::cout << "-----------------" << std::endl;
        std::cout << pythonCode << std::endl;
        std::cout << "-----------------" << std::endl;
        std::cout << "END PYTHON CODE" << std::endl;
        std::cout << "-----------------" << std::endl;
    }
 
    try
    {
        // Import NekPy libraries. This ensures we have all of our boost python
        // wrappers. I guess this could also be done by the calling script...
        auto nekpy    = py::import("NekPy");
        auto multireg = py::import("NekPy.MultiRegions");
 
        // Eval the python code. We can then grab functions etc from the global
        // namespace.
        py::exec(pythonCode.c_str(), m_global, m_global);
    }
    catch (py::error_already_set const &)
    {
        // Parse and output the exception
        ASSERTL0(false,
                 "Failed to load Python code: " + parse_python_exception());
    }
 
    // Give the option as well to just create a filter that's defined via
    // Python.
    it = pParams.find("FilterName");
    if (it != pParams.end())
    {
        std::string filterName = it->second;
 
        // Check filter factory to make sure we have this class.
        ASSERTL0(GetFilterFactory().ModuleExists(filterName),
                 "Unable to locate filter named '" + filterName + "'");
 
        try
        {
            m_pyFilter = GetFilterFactory().CreateInstance(filterName, pSession,
                                                           pEquation, pParams);
        }
        catch (py::error_already_set const &)
        {
            // Parse and output the exception
            ASSERTL0(false,
                     "Failed to load Python code: " + parse_python_exception());
        }
    }
}

References ASSERTL0, Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::SolverUtils::GetFilterFactory(), m_global, m_pyFilter, and Nektar::SolverUtils::parse_python_exception().

~FilterPython()

Nektar::SolverUtils::FilterPython::~FilterPython ( )

override

Definition at line 221 of file FilterPython.cpp.

{
}

Member Function Documentation

create()

static FilterSharedPtr Nektar::SolverUtils::FilterPython::create ( const LibUtilities::SessionReaderSharedPtr &  pSession, const std::shared_ptr< EquationSystem > &  pEquation, const std::map< std::string, std::string > &  pParams  )

inlinestatic

Creates an instance of this class.

Definition at line 49 of file FilterPython.h.

    {
        FilterSharedPtr p = MemoryManager<FilterPython>::AllocateSharedPtr(
            pSession, pEquation, pParams);
        return p;
    }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and CellMLToNektar.cellml_metadata::p.

v_Finalise()

void Nektar::SolverUtils::FilterPython::v_Finalise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields, const NekDouble &  time  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 269 of file FilterPython.cpp.

{
    try
    {
        if (m_pyFilter)
        {
            m_pyFilter->Finalise(pFields, time);
        }
        else
        {
            m_global["filter_finalise"](ArrayOneDToPyList(pFields), time);
        }
    }
    catch (py::error_already_set const &)
    {
        std::cout << "Error in Python: " << parse_python_exception()
                  << std::endl;
    }
}

References Nektar::SolverUtils::ArrayOneDToPyList(), m_global, m_pyFilter, and Nektar::SolverUtils::parse_python_exception().

v_Initialise()

void Nektar::SolverUtils::FilterPython::v_Initialise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields, const NekDouble &  time  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 225 of file FilterPython.cpp.

{
    try
    {
        if (m_pyFilter)
        {
            m_pyFilter->Initialise(pFields, time);
        }
        else
        {
            m_global["filter_initialise"](ArrayOneDToPyList(pFields), time);
        }
    }
    catch (py::error_already_set const &)
    {
        std::cout << "Error in Python: " << parse_python_exception()
                  << std::endl;
    }
}

References Nektar::SolverUtils::ArrayOneDToPyList(), m_global, m_pyFilter, and Nektar::SolverUtils::parse_python_exception().

v_IsTimeDependent()

bool Nektar::SolverUtils::FilterPython::v_IsTimeDependent ( )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 291 of file FilterPython.cpp.

{
    if (m_pyFilter)
    {
        return m_pyFilter->IsTimeDependent();
    }
 
    return true;
}

References m_pyFilter.

v_Update()

void Nektar::SolverUtils::FilterPython::v_Update ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields, const NekDouble &  time  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Filter.

Definition at line 247 of file FilterPython.cpp.

{
    try
    {
        if (m_pyFilter)
        {
            m_pyFilter->Update(pFields, time);
        }
        else
        {
            m_global["filter_update"](ArrayOneDToPyList(pFields), time);
        }
    }
    catch (py::error_already_set const &)
    {
        std::cout << "Error in Python: " << parse_python_exception()
                  << std::endl;
    }
}

References Nektar::SolverUtils::ArrayOneDToPyList(), m_global, m_pyFilter, and Nektar::SolverUtils::parse_python_exception().

Friends And Related Function Documentation

MemoryManager< FilterPython >

friend class MemoryManager< FilterPython >

friend

Definition at line 1 of file FilterPython.h.

Member Data Documentation

className

std::string Nektar::SolverUtils::FilterPython::className

static

Initial value:

=
    GetFilterFactory().RegisterCreatorFunction("Python", FilterPython::create)

Name of the class.

Definition at line 60 of file FilterPython.h.

m_fld

LibUtilities::FieldIOSharedPtr Nektar::SolverUtils::FilterPython::m_fld

private

Definition at line 81 of file FilterPython.h.

m_global

py::object Nektar::SolverUtils::FilterPython::m_global

private

Definition at line 82 of file FilterPython.h.

Referenced by FilterPython(), v_Finalise(), v_Initialise(), and v_Update().

m_pyFilter

std::shared_ptr<Filter> Nektar::SolverUtils::FilterPython::m_pyFilter = nullptr

private

Definition at line 83 of file FilterPython.h.

Referenced by FilterPython(), v_Finalise(), v_Initialise(), v_IsTimeDependent(), and v_Update().