Opm::Main Class Reference

#include <Main.hpp>

Inheritance diagram for Opm::Main:

Public Member Functions
	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)
	~Main ()
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}

Constructor & Destructor Documentation

Main() [1/3]

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

Main() [2/3]

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

explicit

Main() [3/3]

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()

Opm::Main::~Main

(

)

Member Function Documentation

initialize_()

template<class TypeTagEarlyBird >

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

inlineprotected

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 argc_, argv_, Opm::FlowGenericVanguard::comm(), Opm::compileTimestamp(), Opm::moduleVersion(), Opm::moduleVersionName(), outputCout_, Opm::gpuistl::printDevice(), Opm::printFlowBanner(), and Opm::Parameters::printValues().

initMPI()

void Opm::Main::initMPI

(

)

justInitialize()

int Opm::Main::justInitialize ( )

inline

Used for test_outputdir.

maybeRedirectReservoirCouplingSlaveOutput_()

void Opm::Main::maybeRedirectReservoirCouplingSlaveOutput_

(

)

maybeSaveReservoirCouplingSlaveLogFilename_()

void Opm::Main::maybeSaveReservoirCouplingSlaveLogFilename_

(

)

runDynamic()

int Opm::Main::runDynamic ( )

inline

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 ( )

inline

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.

setArgvArgc_()

void Opm::Main::setArgvArgc_

(

const std::string &

filename

)

setupVanguard()

void Opm::Main::setupVanguard ( )

protected

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

Member Data Documentation

argc_

int Opm::Main::argc_ {0}

protected

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

argv_

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

protected

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

outputCout_

bool Opm::Main::outputCout_ {false}

protected

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

outputFiles_

bool Opm::Main::outputFiles_ {false}

protected

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

---

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

• Main.hpp