Opm::PyMain< TypeTag > Class Template Reference

#include <PyMain.hpp>

Inheritance diagram for Opm::PyMain< TypeTag >:

Public Types
using	FlowMainType = FlowMain< TypeTag >

Public Member Functions
void	setArguments (const std::vector< std::string > &args)
std::unique_ptr< FlowMainType >	initFlowBlackoil (int &exitCode)
	Main (int argc, char **argv, bool ownMPI=true)
	Main (const std::string &filename, bool mpi_init=true, bool mpi_finalize=true)
	Main (const std::string &filename, std::shared_ptr< EclipseState > eclipseState, std::shared_ptr< Schedule > schedule, std::shared_ptr< SummaryConfig > summaryConfig, bool mpi_init=true, bool mpi_finalize=true)
void	setArgvArgc_ (const std::string &filename)
void	maybeSaveReservoirCouplingSlaveLogFilename_ ()
void	maybeRedirectReservoirCouplingSlaveOutput_ ()
void	initMPI ()
int	runDynamic ()
template<class TypeTag >
int	runStatic ()
int	justInitialize ()
	Used for test_outputdir. More...

Protected Member Functions
template<class TypeTagEarlyBird >
bool	initialize_ (int &exitCode, bool keepKeywords=false)
	Initialize. More...
void	setupVanguard ()

Protected Attributes
int	argc_ {0}
char **	argv_ {nullptr}
bool	outputCout_ {false}
bool	outputFiles_ {false}

Member Typedef Documentation

FlowMainType

template<class TypeTag >

using Opm::PyMain< TypeTag >::FlowMainType = FlowMain<TypeTag>

Member Function Documentation

initFlowBlackoil()

template<class TypeTag >

std::unique_ptr< FlowMainType > Opm::PyMain< TypeTag >::initFlowBlackoil ( int &  exitCode )

inline

References Opm::Main::argc_, Opm::Main::argv_, Opm::Main::outputCout_, Opm::Main::outputFiles_, and Opm::Main::setupVanguard().

initialize_()

template<class TypeTagEarlyBird >

bool Opm::Main::initialize_ ( int &  exitCode, bool  keepKeywords = false  )

inlineprotectedinherited

Initialize.

Parameters

exitCode	The exitCode of the program.
keepKeywords	Keep Schedule keywords even if there are no actions

Returns

Whether to actually run the simulator. I.e. true if parsing of command line was successful and no –help, –print-properties, or –print-parameters have been found.

References Opm::Main::argc_, Opm::Main::argv_, Opm::FlowGenericVanguard::comm(), Opm::compileTimestamp(), Opm::moduleVersion(), Opm::moduleVersionName(), Opm::Main::outputCout_, Opm::gpuistl::printDevice(), Opm::printFlowBanner(), and Opm::Parameters::printValues().

initMPI()

void Opm::Main::initMPI ( )

inherited

justInitialize()

int Opm::Main::justInitialize ( )

inlineinherited

Used for test_outputdir.

Main() [1/3]

template<class TypeTag >

Opm::Main::Main ( const std::string &  filename, bool  mpi_init = true, bool  mpi_finalize = true  )

explicit

Main() [2/3]

template<class TypeTag >

Opm::Main::Main	(	const std::string &	filename,
		std::shared_ptr< EclipseState >	eclipseState,
		std::shared_ptr< Schedule >	schedule,
		std::shared_ptr< SummaryConfig >	summaryConfig,
		bool	mpi_init = true,
		bool	mpi_finalize = true
	)

Main() [3/3]

template<class TypeTag >

Opm::Main::Main	(	int	argc,
		char **	argv,
		bool	ownMPI = true
	)

maybeRedirectReservoirCouplingSlaveOutput_()

void Opm::Main::maybeRedirectReservoirCouplingSlaveOutput_ ( )

inherited

maybeSaveReservoirCouplingSlaveLogFilename_()

void Opm::Main::maybeSaveReservoirCouplingSlaveLogFilename_ ( )

inherited

runDynamic()

int Opm::Main::runDynamic ( )

inlineinherited

Run simulation.

Selects an appropriate simulator based on runtime information in the input deck.

Returns

Simulation's status/exit code.

References Opm::Parameters::reset().

runStatic()

template<class TypeTag >

int Opm::Main::runStatic ( )

inlineinherited

Run simulation.

Uses staticially configured simulator defined at call site.

Template Parameters

TypeTag

Simulation type's statically configured properties.

Returns

Simulation's status/exit code.

setArguments()

template<class TypeTag >

void Opm::PyMain< TypeTag >::setArguments ( const std::vector< std::string > &  args )

inline

References Opm::Main::argc_, and Opm::Main::argv_.

setArgvArgc_()

void Opm::Main::setArgvArgc_ ( const std::string &  filename )

inherited

setupVanguard()

void Opm::Main::setupVanguard ( )

protectedinherited

Referenced by Opm::PyMain< TypeTag >::initFlowBlackoil().

Member Data Documentation

argc_

int Opm::Main::argc_ {0}

protectedinherited

Referenced by Opm::PyMain< TypeTag >::initFlowBlackoil(), Opm::Main::initialize_(), and Opm::PyMain< TypeTag >::setArguments().

argv_

char** Opm::Main::argv_ {nullptr}

protectedinherited

Referenced by Opm::PyMain< TypeTag >::initFlowBlackoil(), Opm::Main::initialize_(), and Opm::PyMain< TypeTag >::setArguments().

outputCout_

bool Opm::Main::outputCout_ {false}

protectedinherited

Referenced by Opm::PyMain< TypeTag >::initFlowBlackoil(), and Opm::Main::initialize_().

outputFiles_

bool Opm::Main::outputFiles_ {false}

protectedinherited

Referenced by Opm::PyMain< TypeTag >::initFlowBlackoil().

---

The documentation for this class was generated from the following file:

• PyMain.hpp