Python/BasicUtils/SessionReader.cpp File Reference

#include "../NekPyConvertors.hpp"
#include <LibUtilities/BasicUtils/SessionReader.h>
#include <LibUtilities/Python/NekPyConfig.hpp>

Go to the source code of this file.

Functions
SessionReaderSharedPtr	SessionReader_CreateInstance (py::list &ns)
void	SessionReader_SetParameterInt (SessionReaderSharedPtr session, std::string paramName, int paramValue)
void	SessionReader_SetParameterDouble (SessionReaderSharedPtr session, std::string paramName, double paramValue)
EquationSharedPtr	SessionReader_GetFunction1 (SessionReaderSharedPtr session, std::string func, int var)
EquationSharedPtr	SessionReader_GetFunction2 (SessionReaderSharedPtr session, std::string func, std::string var)
py::dict	SessionReader_GetParameters (SessionReaderSharedPtr s)
	Function to wrap SessionReader::GetParameters. More...
py::list	SessionReader_GetVariables (SessionReaderSharedPtr s)
	Function to wrap SessionReader::GetVariables. More...
void	export_SessionReader ()
	SessionReader exports. More...

Function Documentation

export_SessionReader()

void export_SessionReader

(

)

SessionReader exports.

Currently wrapped functions:

• SessionReader::CreateInstance for creating objects
• SessionReader::GetSessionName to return the session name
• SessionReader::Finalise to deal with finalising things

Definition at line 146 of file Python/BasicUtils/SessionReader.cpp.

{
    py::class_<SessionReader, std::shared_ptr<SessionReader>,
               boost::noncopyable>("SessionReader", py::no_init)
 
        .def("CreateInstance", SessionReader_CreateInstance)
        .staticmethod("CreateInstance")
 
        .def("GetSessionName", &SessionReader::GetSessionName,
             py::return_value_policy<py::copy_const_reference>())
 
        .def("Finalise", &SessionReader::Finalise)
 
        .def("DefinesParameter", &SessionReader::DefinesParameter)
        .def("GetParameter", &SessionReader::GetParameter,
             py::return_value_policy<py::return_by_value>())
        .def("GetParameters", &SessionReader_GetParameters)
 
        .def("SetParameter", SessionReader_SetParameterInt)
        .def("SetParameter", SessionReader_SetParameterDouble)
 
        .def("DefinesSolverInfo", &SessionReader::DefinesSolverInfo)
        .def("GetSolverInfo", &SessionReader::GetSolverInfo,
             py::return_value_policy<py::copy_const_reference>())
        .def("SetSolverInfo", &SessionReader::SetSolverInfo)
 
        .def("GetVariable", &SessionReader::GetVariable,
             py::return_value_policy<py::copy_const_reference>())
        .def("GetVariables", SessionReader_GetVariables)
 
        .def("GetFunction", SessionReader_GetFunction1)
        .def("GetFunction", SessionReader_GetFunction2)
 
        .def("GetComm", &SessionReader::GetComm)
 
        .def("GetSharedFilesystem", &SessionReader::GetSharedFilesystem);
}

References Gs::Finalise(), SessionReader_CreateInstance(), SessionReader_GetFunction1(), SessionReader_GetFunction2(), SessionReader_GetParameters(), SessionReader_GetVariables(), SessionReader_SetParameterDouble(), and SessionReader_SetParameterInt().

Referenced by BOOST_PYTHON_MODULE().

SessionReader_CreateInstance()

SessionReaderSharedPtr SessionReader_CreateInstance

(

py::list &

ns

)

Definition at line 57 of file Python/BasicUtils/SessionReader.cpp.

{
    CppCommandLine cpp(ns);
 
    int argc    = cpp.GetArgc();
    char **argv = cpp.GetArgv();
 
#ifdef NEKTAR_USE_MPI
    // In the case we're using MPI, it may already have been initialised. So to
    // handle this, we'll construct our own CommMpi object and pass through to
    // the SessionReader. This will persist indefinitely, or at least until the
    // library is unloaded by Python.
 
    if (!MPICOMM)
    {
        MPICOMM = GetCommFactory().CreateInstance("ParallelMPI", argc, argv);
    }
 
    std::vector<std::string> filenames(argc - 1);
    for (int i = 1; i < argc; ++i)
    {
        filenames[i - 1] = std::string(argv[i]);
    }
 
    // Create session reader.
    SessionReaderSharedPtr sr =
        SessionReader::CreateInstance(argc, argv, filenames, MPICOMM);
#else
    // Create session reader.
    SessionReaderSharedPtr sr = SessionReader::CreateInstance(argc, argv);
#endif
 
    return sr;
}

References Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), CppCommandLine::GetArgc(), CppCommandLine::GetArgv(), and Nektar::LibUtilities::GetCommFactory().

Referenced by export_SessionReader().

SessionReader_GetFunction1()

EquationSharedPtr SessionReader_GetFunction1	(	SessionReaderSharedPtr	session,
		std::string	func,
		int	var
	)

Definition at line 104 of file Python/BasicUtils/SessionReader.cpp.

{
    return session->GetFunction(func, var);
}

Referenced by export_SessionReader().

SessionReader_GetFunction2()

EquationSharedPtr SessionReader_GetFunction2	(	SessionReaderSharedPtr	session,
		std::string	func,
		std::string	var
	)

Definition at line 110 of file Python/BasicUtils/SessionReader.cpp.

{
    return session->GetFunction(func, var);
}

Referenced by export_SessionReader().

SessionReader_GetParameters()

py::dict SessionReader_GetParameters

(

SessionReaderSharedPtr

s

)

Function to wrap SessionReader::GetParameters.

Returns a Python dict containing (parameter name)-> (parameter value) entries.

Definition at line 122 of file Python/BasicUtils/SessionReader.cpp.

{
    return MapToPyDict(s->GetParameters());
}

References MapToPyDict().

Referenced by export_SessionReader().

SessionReader_GetVariables()

py::list SessionReader_GetVariables

(

SessionReaderSharedPtr

s

)

Function to wrap SessionReader::GetVariables.

Returns a Python list containing variable names.

Definition at line 132 of file Python/BasicUtils/SessionReader.cpp.

{
    return VectorToPyList(s->GetVariables());
}

References VectorToPyList().

Referenced by export_SessionReader().

SessionReader_SetParameterDouble()

void SessionReader_SetParameterDouble	(	SessionReaderSharedPtr	session,
		std::string	paramName,
		double	paramValue
	)

Definition at line 98 of file Python/BasicUtils/SessionReader.cpp.

{
    session->SetParameter(paramName, paramValue);
}

Referenced by export_SessionReader().

SessionReader_SetParameterInt()

void SessionReader_SetParameterInt	(	SessionReaderSharedPtr	session,
		std::string	paramName,
		int	paramValue
	)

Definition at line 92 of file Python/BasicUtils/SessionReader.cpp.

{
    session->SetParameter(paramName, paramValue);
}

Referenced by export_SessionReader().