fvbaseproblem.hh
Go to the documentation of this file.
Definition: restrictprolong.hh:142 Base class for all problems which use a finite volume spatial discretization. Definition: fvbaseproblem.hh:67 static int handlePositionalParameter(std::function< void(const std::string &, const std::string &)>, std::set< std::string > &, std::string &errorMsg, int, const char **argv, int paramIdx, int) Handles positional command line parameters. Definition: fvbaseproblem.hh:256 const Simulator & simulator() const Returns Simulator object used by the simulation. Definition: fvbaseproblem.hh:688 void writeOutput(bool verbose=true) Write the relevant secondary variables of the current solution into an VTK output file. Definition: fvbaseproblem.hh:780 void boundary(BoundaryRateVector &, const Context &, unsigned, unsigned) const Evaluate the boundary conditions for a boundary segment. Definition: fvbaseproblem.hh:313 void finalize() Called after the simulation has been run sucessfully. Definition: fvbaseproblem.hh:451 Simulator & simulator() Returns Simulator object used by the simulation. Definition: fvbaseproblem.hh:682 const Model & model() const Returns numerical model used for the problem. Definition: fvbaseproblem.hh:700 static void registerParameters() Registers all available parameters for the problem and the model. Definition: fvbaseproblem.hh:170 void source(RateVector &, const Context &, unsigned, unsigned) const Evaluate the source term for all phases within a given sub-control-volume. Definition: fvbaseproblem.hh:349 bool recycleFirstIterationStorage() const Return if the storage term of the first iteration is identical to the storage term for the solution o... Definition: fvbaseproblem.hh:195 unsigned maxTimeIntegrationFailures() const Returns the maximum number of subsequent failures for the time integration before giving up. Definition: fvbaseproblem.hh:565 unsigned markForGridAdaptation() Mark grid cells for refinement or coarsening. Definition: fvbaseproblem.hh:732 void serialize(Restarter &res) This method writes the complete state of the problem to the harddisk. Definition: fvbaseproblem.hh:751 void beginIteration() Called by the simulator before each Newton-Raphson iteration. Definition: fvbaseproblem.hh:418 void endTimeStep() Called by the simulator after each time integration. Definition: fvbaseproblem.hh:433 FvBaseProblem(Simulator &simulator) Definition: fvbaseproblem.hh:117 const GlobalPosition & boundingBoxMax() const The coordinate of the corner of the GridView's bounding box with the largest values. Definition: fvbaseproblem.hh:664 RestrictProlongOperator restrictProlongOperator() return restriction and prolongation operator Definition: fvbaseproblem.hh:720 void timeIntegration() Called by Opm::Simulator in order to do a time integration on the model. Definition: fvbaseproblem.hh:508 Model & model() Returns numerical model used for the problem. Definition: fvbaseproblem.hh:694 void endEpisode() Called when the end of an simulation episode is reached. Definition: fvbaseproblem.hh:441 void beginTimeStep() Called by the simulator before each time integration. Definition: fvbaseproblem.hh:412 static std::string helpPreamble(int, const char **argv) Returns the string that is printed before the list of command line parameters in the help message. Definition: fvbaseproblem.hh:217 void deserialize(Restarter &res) This method restores the complete state of the problem from disk. Definition: fvbaseproblem.hh:768 void prefetch(const Element &) const Allows to improve the performance by prefetching all data which is associated with a given element. Definition: fvbaseproblem.hh:281 Scalar extrusionFactor(const Context &, unsigned, unsigned) const Return how much the domain is extruded at a given sub-control volume. Definition: fvbaseproblem.hh:388 bool shouldWriteRestartFile() const Returns true if a restart file should be written to disk. Definition: fvbaseproblem.hh:612 Scalar nextTimeStepSize() const Called by Opm::Simulator whenever a solution for a time step has been computed and the simulation tim... Definition: fvbaseproblem.hh:587 Scalar minTimeStepSize() const Returns the minimum allowable size of a time step. Definition: fvbaseproblem.hh:558 void beginEpisode() Called at the beginning of an simulation episode. Definition: fvbaseproblem.hh:406 void initial(PrimaryVariables &, const Context &, unsigned, unsigned) const Evaluate the initial value for a control volume. Definition: fvbaseproblem.hh:366 std::string outputDir() const Determine the directory for simulation output. Definition: fvbaseproblem.hh:206 const VertexMapper & vertexMapper() const Returns the mapper for vertices to indices. Definition: fvbaseproblem.hh:670 void gridChanged() Handle changes of the grid. Definition: fvbaseproblem.hh:289 const GlobalPosition & boundingBoxMin() const The coordinate of the corner of the GridView's bounding box with the smallest values. Definition: fvbaseproblem.hh:657 static std::string briefDescription() Returns a human readable description of the problem for the help message. Definition: fvbaseproblem.hh:235 void endIteration() Called by the simulator after each Newton-Raphson update. Definition: fvbaseproblem.hh:424 void setNextTimeStepSize(Scalar dt) Impose the next time step size to be used externally. Definition: fvbaseproblem.hh:579 bool continueOnConvergenceError() const Returns if we should continue with a non-converged solution instead of giving up if we encounter a ti... Definition: fvbaseproblem.hh:573 void constraints(Constraints &, const Context &, unsigned, unsigned) const Evaluate the constraints for a control volume. Definition: fvbaseproblem.hh:330 void finishInit() Called by the Opm::Simulator in order to initialize the problem. Definition: fvbaseproblem.hh:274 const NewtonMethod & newtonMethod() const Returns object which implements the Newton method. Definition: fvbaseproblem.hh:712 const GridView & gridView() const The GridView which used by the problem. Definition: fvbaseproblem.hh:650 EmptyRestrictProlong RestrictProlongOperator Definition: fvbaseproblem.hh:103 NewtonMethod & newtonMethod() Returns object which implements the Newton method. Definition: fvbaseproblem.hh:706 bool shouldWriteOutput() const Returns true if the current solution should be written to disk (i.e. as a VTK file) Definition: fvbaseproblem.hh:626 void initialSolutionApplied() Callback used by the model to indicate that the initial solution has been determined for all degrees ... Definition: fvbaseproblem.hh:400 void advanceTimeLevel() Called by the simulator after everything which can be done about the current time step is finished an... Definition: fvbaseproblem.hh:634 VtkMultiWriter & defaultVtkWriter() const Method to retrieve the VTK writer which should be used to write the default ouput after each time ste... Definition: fvbaseproblem.hh:803 const ElementMapper & elementMapper() const Returns the mapper for elements to indices. Definition: fvbaseproblem.hh:676 static unsigned maxThreads() Return the maximum number of threads of the current process. Definition: threadmanager.hpp:66 void endWrite(bool onlyDiscard=false) Finalizes the current writer. Definition: vtkmultiwriter.hh:389 void deserialize(Restarter &res) Read the multi-writer's state from a restart file. Definition: vtkmultiwriter.hh:442 void gridChanged() Updates the internal data structures after mesh refinement. Definition: vtkmultiwriter.hh:165 void beginWrite(double t) Called whenever a new time step must be written. Definition: vtkmultiwriter.hh:179 void serialize(Restarter &res) Write the multi-writer's state to a restart file. Definition: vtkmultiwriter.hh:408 Declare the properties used by the infrastructure code of the finite volume discretizations. Declare the properties used by the infrastructure code of the finite volume discretizations. Definition: fvbaseprimaryvariables.hh:141 auto Get(bool errorIfNotRegistered=true) Retrieve a runtime parameter. Definition: parametersystem.hpp:185 Definition: blackoilmodel.hh:72 Definition: blackoilboundaryratevector.hh:37 std::string humanReadableTime(double timeInSeconds, bool isAmendment=true) Given a time step size in seconds, return it in a format which is more easily parsable by humans. std::string simulatorOutputDir() Determine and check the configured directory for simulation output. typename Properties::Detail::GetPropImpl< TypeTag, Property >::type::type GetPropType get the type alias defined in the property (equivalent to old macro GET_PROP_TYPE(.... Definition: propertysystem.hh:235 std::string to_string(const ConvergenceReport::ReservoirFailure::Type t) Specify the maximum size of a time integration [s]. Definition: fvbaseparameters.hh:106 |