Opm::FlowMain< TypeTag > Class Template Reference

#include <FlowMain.hpp>

Public Types
using	MaterialLawManager = typename GetProp< TypeTag, Properties::MaterialLaw >::EclMaterialLawManager
using	ModelSimulator = GetPropType< TypeTag, Properties::Simulator >
using	Grid = GetPropType< TypeTag, Properties::Grid >
using	GridView = GetPropType< TypeTag, Properties::GridView >
using	Problem = GetPropType< TypeTag, Properties::Problem >
using	Scalar = GetPropType< TypeTag, Properties::Scalar >
using	FluidSystem = GetPropType< TypeTag, Properties::FluidSystem >
using	Simulator = SimulatorFullyImplicitBlackoil< TypeTag >

Public Member Functions
	FlowMain (int argc, char **argv, bool output_cout, bool output_files)
int	execute ()
int	executeInitStep ()
int	executeStep ()
int	executeStepsCleanup ()
ModelSimulator *	getSimulatorPtr ()
SimulatorTimer *	getSimTimer ()
double	getPreviousReportStepSize ()
	Get the size of the previous report step. More...

Static Public Member Functions
static int	setupParameters_ (int argc, char **argv, Parallel::Communication comm)

Protected Member Functions
void	setupParallelism ()
void	mergeParallelLogFiles ()
void	setupModelSimulator ()
const EclipseState &	eclState () const
EclipseState &	eclState ()
const Schedule &	schedule () const
int	runSimulator ()
int	runSimulatorInit ()
void	createSimulator ()
	This is the main function of Flow. More...
Grid &	grid ()

Member Typedef Documentation

FluidSystem

template<class TypeTag >

using Opm::FlowMain< TypeTag >::FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>

Grid

template<class TypeTag >

using Opm::FlowMain< TypeTag >::Grid = GetPropType<TypeTag, Properties::Grid>

GridView

template<class TypeTag >

using Opm::FlowMain< TypeTag >::GridView = GetPropType<TypeTag, Properties::GridView>

MaterialLawManager

template<class TypeTag >

using Opm::FlowMain< TypeTag >::MaterialLawManager = typename GetProp<TypeTag, Properties::MaterialLaw>::EclMaterialLawManager

ModelSimulator

template<class TypeTag >

using Opm::FlowMain< TypeTag >::ModelSimulator = GetPropType<TypeTag, Properties::Simulator>

Problem

template<class TypeTag >

using Opm::FlowMain< TypeTag >::Problem = GetPropType<TypeTag, Properties::Problem>

Scalar

template<class TypeTag >

using Opm::FlowMain< TypeTag >::Scalar = GetPropType<TypeTag, Properties::Scalar>

Simulator

template<class TypeTag >

using Opm::FlowMain< TypeTag >::Simulator = SimulatorFullyImplicitBlackoil<TypeTag>

Constructor & Destructor Documentation

FlowMain()

template<class TypeTag >

Opm::FlowMain< TypeTag >::FlowMain ( int  argc, char **  argv, bool  output_cout, bool  output_files  )

inline

Member Function Documentation

createSimulator()

template<class TypeTag >

void Opm::FlowMain< TypeTag >::createSimulator ( )

inlineprotected

This is the main function of Flow.

eclState() [1/2]

template<class TypeTag >

EclipseState & Opm::FlowMain< TypeTag >::eclState ( )

inlineprotected

eclState() [2/2]

template<class TypeTag >

const EclipseState & Opm::FlowMain< TypeTag >::eclState ( ) const

inlineprotected

Referenced by Opm::FlowMain< TypeTag >::mergeParallelLogFiles(), and Opm::FlowMain< TypeTag >::setupModelSimulator().

execute()

template<class TypeTag >

int Opm::FlowMain< TypeTag >::execute ( )

inline

This is the main function of Flow. It runs a complete simulation with the given grid and simulator classes, based on the user-specified command-line input.

References Opm::FlowMain< TypeTag >::runSimulator().

Referenced by Opm::flowMain().

executeInitStep()

template<class TypeTag >

int Opm::FlowMain< TypeTag >::executeInitStep ( )

inline

References Opm::FlowMain< TypeTag >::runSimulatorInit().

executeStep()

template<class TypeTag >

int Opm::FlowMain< TypeTag >::executeStep ( )

inline

executeStepsCleanup()

template<class TypeTag >

int Opm::FlowMain< TypeTag >::executeStepsCleanup ( )

inline

References Opm::SimulatorReportSingle::exit_status, and Opm::SimulatorReport::success.

getPreviousReportStepSize()

template<class TypeTag >

double Opm::FlowMain< TypeTag >::getPreviousReportStepSize ( )

inline

Get the size of the previous report step.

getSimTimer()

template<class TypeTag >

SimulatorTimer * Opm::FlowMain< TypeTag >::getSimTimer ( )

inline

getSimulatorPtr()

template<class TypeTag >

ModelSimulator * Opm::FlowMain< TypeTag >::getSimulatorPtr ( )

inline

grid()

template<class TypeTag >

Grid & Opm::FlowMain< TypeTag >::grid ( )

inlineprotected

mergeParallelLogFiles()

template<class TypeTag >

void Opm::FlowMain< TypeTag >::mergeParallelLogFiles ( )

inlineprotected

References Opm::FlowMain< TypeTag >::eclState(), and Opm::detail::mergeParallelLogFiles().

runSimulator()

template<class TypeTag >

int Opm::FlowMain< TypeTag >::runSimulator ( )

inlineprotected

Referenced by Opm::FlowMain< TypeTag >::execute().

runSimulatorInit()

template<class TypeTag >

int Opm::FlowMain< TypeTag >::runSimulatorInit ( )

inlineprotected

Referenced by Opm::FlowMain< TypeTag >::executeInitStep().

schedule()

template<class TypeTag >

const Schedule & Opm::FlowMain< TypeTag >::schedule ( ) const

inlineprotected

setupModelSimulator()

template<class TypeTag >

void Opm::FlowMain< TypeTag >::setupModelSimulator ( )

inlineprotected

References Opm::FlowGenericVanguard::comm(), and Opm::FlowMain< TypeTag >::eclState().

setupParallelism()

template<class TypeTag >

void Opm::FlowMain< TypeTag >::setupParallelism ( )

inlineprotected

References Opm::FlowGenericVanguard::comm().

setupParameters_()

template<class TypeTag >

static int Opm::FlowMain< TypeTag >::setupParameters_ ( int  argc, char **  argv, Parallel::Communication  comm  )

inlinestatic

References Opm::SimulatorFullyImplicitBlackoil< TypeTag >::registerParameters().

---

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

• FlowMain.hpp