My Project
Loading...
Searching...
No Matches
Opm::SimulatorFullyImplicitBlackoil< TypeTag > Class Template Reference

a simulator for the blackoil model More...

#include <SimulatorFullyImplicitBlackoil.hpp>

Inheritance diagram for Opm::SimulatorFullyImplicitBlackoil< TypeTag >:
Opm::SerializableSim

Public Types

using Simulator = GetPropType<TypeTag, Properties::Simulator>
 
using Grid = GetPropType<TypeTag, Properties::Grid>
 
using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>
 
using ElementContext = GetPropType<TypeTag, Properties::ElementContext>
 
using BlackoilIndices = GetPropType<TypeTag, Properties::Indices>
 
using PrimaryVariables = GetPropType<TypeTag, Properties::PrimaryVariables>
 
using MaterialLaw = GetPropType<TypeTag, Properties::MaterialLaw>
 
using SolutionVector = GetPropType<TypeTag, Properties::SolutionVector>
 
using MaterialLawParams = GetPropType<TypeTag, Properties::MaterialLawParams>
 
using AquiferModel = GetPropType<TypeTag, Properties::AquiferModel>
 
using TimeStepper = AdaptiveTimeStepping<TypeTag>
 
using PolymerModule = BlackOilPolymerModule<TypeTag>
 
using MICPModule = BlackOilMICPModule<TypeTag>
 
using Model = BlackoilModel<TypeTag>
 
using Solver = NonlinearSolver<TypeTag, Model>
 
using ModelParameters = typename Model::ModelParameters
 
using SolverParameters = typename Solver::SolverParameters
 
using WellModel = BlackoilWellModel<TypeTag>
 

Public Member Functions

 SimulatorFullyImplicitBlackoil (Simulator &simulator)
 Initialise from parameters and objects to observe.
 
SimulatorReport run (SimulatorTimer &timer)
 Run the simulation.
 
void init (SimulatorTimer &timer)
 
void updateTUNING (const Tuning &tuning)
 
bool runStep (SimulatorTimer &timer)
 
SimulatorReport finalize ()
 
const Grid & grid () const
 
template<class Serializer >
void serializeOp (Serializer &serializer)
 
const Modelmodel () const
 

Static Public Member Functions

static void registerParameters ()
 

Protected Member Functions

void loadState (HDF5Serializer &serializer, const std::string &groupName) override
 Load simulator state from hdf5 serializer.
 
void saveState (HDF5Serializer &serializer, const std::string &groupName) const override
 Save simulator state using hdf5 serializer.
 
std::array< std::string, 5 > getHeader () const override
 Returns header data.
 
const std::vector< int > & getCellMapping () const override
 Returns local-to-global cell mapping.
 
std::unique_ptr< SolvercreateSolver (WellModel &wellModel)
 
const EclipseState & eclState () const
 
const Schedule & schedule () const
 
bool isRestart () const
 
WellModelwellModel_ ()
 
const WellModelwellModel_ () const
 
void startConvergenceOutputThread (std::string_view convOutputOptions, std::string_view optionName)
 
void writeConvergenceOutput (std::vector< StepReport > &&reports)
 
void endConvergenceOutputThread ()
 

Protected Attributes

Simulator & simulator_
 
ModelParameters modelParam_
 
SolverParameters solverParam_
 
std::unique_ptr< Solversolver_
 
PhaseUsage phaseUsage_
 
bool terminalOutput_
 
SimulatorReport report_
 
std::size_t already_reported_steps_ = 0
 
std::unique_ptr< time::StopWatch > solverTimer_
 
std::unique_ptr< time::StopWatch > totalTimer_
 
std::unique_ptr< TimeStepperadaptiveTimeStepping_
 
std::optional< ConvergenceReportQueueconvergenceOutputQueue_ {}
 
std::optional< ConvergenceOutputThreadconvergenceOutputObject_ {}
 
std::optional< std::thread > convergenceOutputThread_ {}
 
SimulatorSerializer serializer_
 

Detailed Description

template<class TypeTag>
class Opm::SimulatorFullyImplicitBlackoil< TypeTag >

a simulator for the blackoil model

Constructor & Destructor Documentation

◆ SimulatorFullyImplicitBlackoil()

template<class TypeTag >
Opm::SimulatorFullyImplicitBlackoil< TypeTag >::SimulatorFullyImplicitBlackoil ( Simulator & simulator)
inline

Initialise from parameters and objects to observe.

Parameters
[in]paramparameters, this class accepts the following:

parameter (default) effect

output (true) write output to files? output_dir ("output") output directoty output_interval (1) output every nth step nl_pressure_residual_tolerance (0.0) pressure solver residual tolerance (in Pascal) nl_pressure_change_tolerance (1.0) pressure solver change tolerance (in Pascal) nl_pressure_maxiter (10) max nonlinear iterations in pressure nl_maxiter (30) max nonlinear iterations in transport nl_tolerance (1e-9) transport solver absolute residual tolerance num_transport_substeps (1) number of transport steps per pressure step use_segregation_split (false) solve for gravity segregation (if false, segregation is ignored).

Parameters
[in]propsfluid and rock properties
[in]linsolverlinear solver
[in]eclipse_statethe object which represents an internalized ECL deck
[in]output_writer
[in]threshold_pressures_by_faceif nonempty, threshold pressures that inhibit flow

Member Function Documentation

◆ getCellMapping()

template<class TypeTag >
const std::vector< int > & Opm::SimulatorFullyImplicitBlackoil< TypeTag >::getCellMapping ( ) const
inlineoverrideprotectedvirtual

Returns local-to-global cell mapping.

Implements Opm::SerializableSim.

◆ getHeader()

template<class TypeTag >
std::array< std::string, 5 > Opm::SimulatorFullyImplicitBlackoil< TypeTag >::getHeader ( ) const
inlineoverrideprotectedvirtual

Returns header data.

Implements Opm::SerializableSim.

◆ loadState()

template<class TypeTag >
void Opm::SimulatorFullyImplicitBlackoil< TypeTag >::loadState ( HDF5Serializer & serializer,
const std::string & groupName )
inlineoverrideprotectedvirtual

Load simulator state from hdf5 serializer.

Implements Opm::SerializableSim.

◆ run()

template<class TypeTag >
SimulatorReport Opm::SimulatorFullyImplicitBlackoil< TypeTag >::run ( SimulatorTimer & timer)
inline

Run the simulation.

This will run succesive timesteps until timer.done() is true. It will modify the reservoir and well states.

Parameters
[in,out]timergoverns the requested reporting timesteps
[in,out]statestate of reservoir: pressure, fluxes
Returns
simulation report, with timing data

◆ saveState()

template<class TypeTag >
void Opm::SimulatorFullyImplicitBlackoil< TypeTag >::saveState ( HDF5Serializer & serializer,
const std::string & groupName ) const
inlineoverrideprotectedvirtual

Save simulator state using hdf5 serializer.

Implements Opm::SerializableSim.


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