fvbasediscretization.hh
Go to the documentation of this file.
101{ using type = Dune::MultipleCodimMultipleGeomTypeMapper<GetPropType<TypeTag, Properties::GridView>>; };
106{ using type = Dune::MultipleCodimMultipleGeomTypeMapper<GetPropType<TypeTag, Properties::GridView>>; };
570 // Initialize intensive quantities cache now that all problem-specific parameters are available.
571 // This ensures intensiveQuantityHistorySize is correct based on recycleFirstIterationStorage().
644 const IntensiveQuantities* cachedIntensiveQuantities(unsigned globalIdx, unsigned timeIdx) const
748 void invalidateAndUpdateIntensiveQuantities(unsigned timeIdx, const GridViewType& gridView) const
931 // If we cannot recycle first iteration storage, it does not make sense to shift the storage cache.
938 // should we invalidate the cache for the most recent time indices? (see shiftIntensiveQuantityCache)
1578 { throw std::logic_error("The discretization class must implement the numGridDof() method!"); }
1736 DiscBaseOutputModule::attachScalarDofData_(writer, *normalizedRelError, "normalized relative error");
2053 static constexpr unsigned historySize = getPropValue<TypeTag, Properties::TimeDiscHistorySize>();
This is a stand-alone version of boost::alignment::aligned_allocator from Boost 1.... Base class for specifying auxiliary equations. Definition: baseauxiliarymodule.hh:56 virtual void applyInitial()=0 Set the initial condition of the auxiliary module in the solution vector. void setDofOffset(int value) Set the offset in the global system of equations for the first degree of freedom of this auxiliary mo... Definition: baseauxiliarymodule.hh:78 Represents all quantities which available on boundary segments. Definition: fvbaseboundarycontext.hh:46 Represents all quantities which available for calculating constraints. Definition: fvbaseconstraintscontext.hh:44 Class to specify constraints for a finite volume spatial discretization. Definition: fvbaseconstraints.hh:48 Definition: fvbasediscretization.hh:350 const SolutionVector & blockVector() const Definition: fvbasediscretization.hh:373 BlockVectorWrapper()=default SolutionVector blockVector_ Definition: fvbasediscretization.hh:352 void serializeOp(Serializer &serializer) Definition: fvbasediscretization.hh:383 static BlockVectorWrapper serializationTestObject() Definition: fvbasediscretization.hh:360 SolutionVector & blockVector() Definition: fvbasediscretization.hh:370 bool operator==(const BlockVectorWrapper &wrapper) const Definition: fvbasediscretization.hh:376 BlockVectorWrapper(const std::string &, const std::size_t size) Definition: fvbasediscretization.hh:354 The base class for the finite volume discretization schemes without adaptation. Definition: fvbasediscretization.hh:2048 FvBaseDiscretizationNoAdapt(Simulator &simulator) Definition: fvbasediscretization.hh:2069 The base class for the finite volume discretization schemes. Definition: fvbasediscretization.hh:298 Timer linearizeTimer_ Definition: fvbasediscretization.hh:2003 std::vector< IntensiveQuantitiesVector > intensiveQuantityCache_ Definition: fvbasediscretization.hh:2015 LocalLinearizer & localLinearizer(unsigned openMpThreadId) Definition: fvbasediscretization.hh:1269 void prepareOutputFields() const Prepare the quantities relevant for the current solution to be appended to the output writers. Definition: fvbasediscretization.hh:1769 void shiftIntensiveQuantityCache(unsigned numSlots=1) Move the intensive quantities for a given time index to the back. Definition: fvbasediscretization.hh:785 void invalidateAndUpdateIntensiveQuantities(unsigned timeIdx) const Definition: fvbasediscretization.hh:727 void adaptGrid() Called by the update() method when the grid should be refined. Definition: fvbasediscretization.hh:1442 std::vector< BaseAuxiliaryModule< TypeTag > * > auxEqModules_ Definition: fvbasediscretization.hh:1998 const Implementation & asImp_() const Definition: fvbasediscretization.hh:1983 void addAuxiliaryModule(BaseAuxiliaryModule< TypeTag > *auxMod) Add a module for an auxiliary equation. Definition: fvbasediscretization.hh:1833 void setIntensiveQuantitiesCacheEntryValidity(unsigned globalIdx, unsigned timeIdx, bool newValue) const Invalidate the cache for a given intensive quantities object. Definition: fvbasediscretization.hh:692 void finishInit() Apply the initial conditions to the model. Definition: fvbasediscretization.hh:458 void prefetch(const Element &) const Allows to improve the performance by prefetching all data which is associated with a given element. Definition: fvbasediscretization.hh:591 bool enableStorageCache_ Definition: fvbasediscretization.hh:2035 void resizeAndResetIntensiveQuantitiesCache_() Definition: fvbasediscretization.hh:1919 std::vector< Scalar > dofTotalVolume_ Definition: fvbasediscretization.hh:2025 void updateSuccessful() Called by the update() method if it was successful. Definition: fvbasediscretization.hh:1436 static std::string discretizationName() Returns a string of discretization's human-readable name. Definition: fvbasediscretization.hh:1629 unsigned cachedIntensiveQuantityHistorySize() const Get the cached intensive quantity history size. Definition: fvbasediscretization.hh:706 BaseAuxiliaryModule< TypeTag > * auxiliaryModule(unsigned auxEqModIdx) Returns a given module for auxiliary equations. Definition: fvbasediscretization.hh:1873 bool isLocalDof(unsigned globalIdx) const Returns if the overlap of the volume ofa degree of freedom is non-zero. Definition: fvbasediscretization.hh:1209 std::size_t numAuxiliaryModules() const Returns the number of modules for auxiliary equations. Definition: fvbasediscretization.hh:1867 bool operator==(const FvBaseDiscretization &rhs) const Definition: fvbasediscretization.hh:1908 void serializeOp(Serializer &serializer) Definition: fvbasediscretization.hh:1901 std::vector< bool > isLocalDof_ Definition: fvbasediscretization.hh:2026 LocalResidual & localResidual_() Reference to the local residal object. Definition: fvbasediscretization.hh:1971 void registerOutputModules_() Register all output modules which make sense for the model. Definition: fvbasediscretization.hh:1962 bool enableGridAdaptation() const Returns whether the grid ought to be adapted to the solution during the simulation. Definition: fvbasediscretization.hh:523 const NewtonMethod & newtonMethod() const Returns the newton method object. Definition: fvbasediscretization.hh:605 SolutionVector & mutableSolution(unsigned timeIdx) const Definition: fvbasediscretization.hh:1237 void advanceTimeLevel() Called by the problem if a time integration was successful, post processing of the solution is done a... Definition: fvbasediscretization.hh:1480 NewtonMethod & newtonMethod() Returns the newton method object. Definition: fvbasediscretization.hh:599 const VertexMapper & vertexMapper() const Returns the mapper for vertices to indices. Definition: fvbasediscretization.hh:1607 const EqVector & cachedStorage(unsigned globalIdx, unsigned timeIdx) const Retrieve an entry of the cache for the storage term. Definition: fvbasediscretization.hh:843 void updatePVWeights(const ElementContext &) const Update the weights of all primary variables within an element given the complete set of intensive qua... Definition: fvbasediscretization.hh:1662 const Timer & solveTimer() const Definition: fvbasediscretization.hh:1894 void updateFailed() Called by the update() method if it was unsuccessful. This is primary a hook which the actual model c... Definition: fvbasediscretization.hh:1453 void updateBegin() Called by the update() method before it tries to apply the newton method. This is primary a hook whic... Definition: fvbasediscretization.hh:1429 FvBaseDiscretization(const FvBaseDiscretization &)=delete Scalar globalResidual(GlobalEqVector &dest) const Compute the global residual for the current solution vector. Definition: fvbasediscretization.hh:964 LocalResidual & localResidual(unsigned openMpThreadId) Definition: fvbasediscretization.hh:1281 void serializeEntity(std::ostream &outstream, const DofEntity &dof) Write the current solution for a degree of freedom to a restart file. Definition: fvbasediscretization.hh:1535 void setEnableStorageCache(bool enableStorageCache) Set the value of enable storage cache. Definition: fvbasediscretization.hh:827 std::string eqName(unsigned eqIdx) const Given an equation index, return a human readable name. Definition: fvbasediscretization.hh:1649 Scalar eqWeight(unsigned, unsigned) const Returns the relative weight of an equation. Definition: fvbasediscretization.hh:1303 std::array< std::vector< unsigned char >, historySize > storageCacheUpToDate_ Definition: fvbasediscretization.hh:2031 const Timer & prePostProcessTimer() const Definition: fvbasediscretization.hh:1888 Scalar primaryVarWeight(unsigned globalDofIdx, unsigned pvIdx) const Returns the relative weight of a primary variable for calculating relative errors. Definition: fvbasediscretization.hh:1291 void deserialize(Restarter &) Deserializes the state of the model. Definition: fvbasediscretization.hh:1520 void checkConservativeness(Scalar tolerance=-1, bool verbose=false) const Ensure that the difference between the storage terms of the last and of the current time step is cons... Definition: fvbasediscretization.hh:1079 Scalar gridTotalVolume() const Returns the volume of the whole grid which represents the spatial domain. Definition: fvbasediscretization.hh:1216 FvBaseDiscretization(Simulator &simulator) Definition: fvbasediscretization.hh:394 const IntensiveQuantities * thermodynamicHint(unsigned globalIdx, unsigned timeIdx) const Return the thermodynamic hint for a entity on the grid at given time. Definition: fvbasediscretization.hh:623 bool storageCacheIsUpToDate(unsigned globalIdx, unsigned timeIdx) const Returns true if the storage cache entry for a given DOF and time index is up to date. Definition: fvbasediscretization.hh:883 const Timer & updateTimer() const Definition: fvbasediscretization.hh:1897 const Linearizer & linearizer() const Returns the operator linearizer for the global jacobian of the problem. Definition: fvbasediscretization.hh:1245 void updateCachedStorage(unsigned globalIdx, unsigned timeIdx, const EqVector &value) const Set an entry of the cache for the storage term. Definition: fvbasediscretization.hh:867 void addConvergenceVtkFields(VtkMultiWriter &writer, const SolutionVector &u, const GlobalEqVector &deltaU) const Add the vector fields for analysing the convergence of the newton method to the a VTK writer. Definition: fvbasediscretization.hh:1680 Scalar relativeDofError(unsigned vertexIdx, const PrimaryVariables &pv1, const PrimaryVariables &pv2) const Returns the relative error between two vectors of primary variables. Definition: fvbasediscretization.hh:1315 bool enableGridAdaptation_ Definition: fvbasediscretization.hh:2033 Scalar globalResidual(GlobalEqVector &dest, const SolutionVector &u) const Compute the global residual for an arbitrary solution vector. Definition: fvbasediscretization.hh:949 SolutionVector & solution(unsigned timeIdx) Definition: fvbasediscretization.hh:1230 std::array< GlobalEqVector, historySize > storageCache_ Definition: fvbasediscretization.hh:2028 Timer prePostProcessTimer_ Definition: fvbasediscretization.hh:2002 void deserializeEntity(std::istream &instream, const DofEntity &dof) Reads the current solution variables for a degree of freedom from a restart file. Definition: fvbasediscretization.hh:1560 void supplementInitialSolution_(PrimaryVariables &, const Context &, unsigned, unsigned) Definition: fvbasediscretization.hh:1949 const LocalLinearizer & localLinearizer(unsigned openMpThreadId) const Returns the local jacobian which calculates the local stiffness matrix for an arbitrary element. Definition: fvbasediscretization.hh:1263 std::array< std::unique_ptr< DiscreteFunction >, historySize > solution_ Definition: fvbasediscretization.hh:2020 unsigned cachedIntensiveQuantityHistorySize_ Definition: fvbasediscretization.hh:2038 const Timer & linearizeTimer() const Definition: fvbasediscretization.hh:1891 void invalidateAndUpdateIntensiveQuantities(unsigned timeIdx, const GridViewType &gridView) const Definition: fvbasediscretization.hh:748 bool update() Try to progress the model to the next timestep. Definition: fvbasediscretization.hh:1336 std::size_t numAuxiliaryDof() const Returns the number of degrees of freedom (DOFs) of the auxiliary equations. Definition: fvbasediscretization.hh:1583 void clearAuxiliaryModules() Causes the list of auxiliary equations to be cleared. Definition: fvbasediscretization.hh:1857 bool enableIntensiveQuantityCache_ Definition: fvbasediscretization.hh:2034 std::unique_ptr< Linearizer > linearizer_ Definition: fvbasediscretization.hh:2011 const ElementMapper & elementMapper() const Returns the mapper for elements to indices. Definition: fvbasediscretization.hh:1613 void syncOverlap() Syncronize the values of the primary variables on the degrees of freedom that overlap with the neighb... Definition: fvbasediscretization.hh:1421 void appendOutputFields(BaseOutputWriter &writer) const Append the quantities relevant for the current solution to an output writer. Definition: fvbasediscretization.hh:1810 std::list< std::unique_ptr< BaseOutputModule< TypeTag > > > outputModules_ Definition: fvbasediscretization.hh:2022 ElementMapper elementMapper_ Definition: fvbasediscretization.hh:1994 NewtonMethod newtonMethod_ Definition: fvbasediscretization.hh:2000 std::size_t numTotalDof() const Returns the total number of degrees of freedom (i.e., grid plux auxiliary DOFs) Definition: fvbasediscretization.hh:1594 void applyInitialSolution() Applies the initial solution for all degrees of freedom to which the model applies. Definition: fvbasediscretization.hh:530 void updateCachedIntensiveQuantities(const IntensiveQuantities &intQuants, unsigned globalIdx, unsigned timeIdx) const Update the intensive quantity cache for a entity on the grid at given time. Definition: fvbasediscretization.hh:672 std::string primaryVarName(unsigned pvIdx) const Given an primary variable index, return a human readable name. Definition: fvbasediscretization.hh:1637 void invalidateIntensiveQuantitiesCache(unsigned timeIdx) const Invalidate the whole intensive quantity cache for time index. Definition: fvbasediscretization.hh:714 Linearizer & linearizer() Returns the object which linearizes the global system of equations at the current solution. Definition: fvbasediscretization.hh:1252 const BaseAuxiliaryModule< TypeTag > * auxiliaryModule(unsigned auxEqModIdx) const Returns a given module for auxiliary equations. Definition: fvbasediscretization.hh:1879 std::vector< std::vector< unsigned char > > intensiveQuantityCacheUpToDate_ Definition: fvbasediscretization.hh:2018 void globalStorage(EqVector &storage, unsigned timeIdx=0) const Compute the integral over the domain of the storage terms of all conservation quantities. Definition: fvbasediscretization.hh:1024 Scalar dofTotalVolume(unsigned globalIdx) const Returns the volume of a given control volume. Definition: fvbasediscretization.hh:1201 static void registerParameters() Register all run-time parameters for the model. Definition: fvbasediscretization.hh:427 const SolutionVector & solution(unsigned timeIdx) const Reference to the solution at a given history index as a block vector. Definition: fvbasediscretization.hh:1224 bool verbose_() const Returns whether messages should be printed. Definition: fvbasediscretization.hh:1977 void shiftStorageCache(unsigned numSlots=1) const Shift storage cache by a given number of time step slots. Definition: fvbasediscretization.hh:929 const LocalResidual & localResidual(unsigned openMpThreadId) const Returns the object to calculate the local residual function. Definition: fvbasediscretization.hh:1275 std::size_t numGridDof() const Returns the number of degrees of freedom (DOFs) for the computational grid. Definition: fvbasediscretization.hh:1577 Scalar gridTotalVolume_ Definition: fvbasediscretization.hh:2024 const DofMapper & dofMapper() const Mapper to convert the Dune entities of the discretization's degrees of freedoms are to indices. Definition: fvbasediscretization.hh:1601 bool storeIntensiveQuantities() const Returns true if the cache for intensive quantities is enabled. Definition: fvbasediscretization.hh:1885 std::vector< LocalLinearizer > localLinearizer_ Definition: fvbasediscretization.hh:2008 void invalidateStorageCache(unsigned timeIdx) const Invalidate the whole storage cache for a given time index. Definition: fvbasediscretization.hh:909 void serialize(Restarter &) Serializes the current state of the model. Definition: fvbasediscretization.hh:1506 bool enableThermodynamicHints_ Definition: fvbasediscretization.hh:2036 void invalidateStorageCacheEntry(unsigned globalIdx, unsigned timeIdx) const Invalidate the storage cache for a given DOF and time index. Definition: fvbasediscretization.hh:897 VertexMapper vertexMapper_ Definition: fvbasediscretization.hh:1995 void resetLinearizer() Resets the Jacobian matrix linearizer, so that the boundary types can be altered. Definition: fvbasediscretization.hh:1620 bool enableStorageCache() const Returns true iff the storage term is cached. Definition: fvbasediscretization.hh:818 const GridView & gridView() const Reference to the grid view of the spatial domain. Definition: fvbasediscretization.hh:1819 void addOutputModule(std::unique_ptr< BaseOutputModule< TypeTag > > newModule) Add an module for writing visualization output after a timestep. Definition: fvbasediscretization.hh:1668 const IntensiveQuantities * cachedIntensiveQuantities(unsigned globalIdx, unsigned timeIdx) const Return the cached intensive quantities for a entity on the grid at given time. Definition: fvbasediscretization.hh:644 This class stores an array of IntensiveQuantities objects, one intensive quantities object for each o... Definition: fvbaseelementcontext.hh:55 Provide the properties at a face which make sense independently of the conserved quantities. Definition: fvbaseextensivequantities.hh:48 This class calculates gradients of arbitrary quantities at flux integration points using the two-poin... Definition: fvbasegradientcalculator.hh:52 Base class for the model specific class which provides access to all intensive (i.... Definition: fvbaseintensivequantities.hh:45 The common code for the linearizers of non-linear systems of equations. Definition: fvbaselinearizer.hh:78 Element-wise caculation of the residual matrix for models based on a finite volume spatial discretiza... Definition: fvbaselocalresidual.hh:63 Represents the primary variables used by the a model. Definition: fvbaseprimaryvariables.hh:53 This is a grid manager which does not create any border list. Definition: nullborderlistmanager.hh:44 static void registerParameters() Register all run-time parameters for the Newton method. Definition: newtonmethod.hh:136 Manages the initializing and running of time dependent problems. Definition: simulator.hh:84 static unsigned maxThreads() Return the maximum number of threads of the current process. Definition: threadmanager.hpp:66 static unsigned threadId() Return the index of the current OpenMP thread. Provides an STL-iterator like interface to iterate over the enties of a GridView in OpenMP threaded a... Definition: threadedentityiterator.hh:42 bool isFinished(const EntityIterator &it) const Definition: threadedentityiterator.hh:67 EntityIterator increment() Definition: threadedentityiterator.hh:80 EntityIterator beginParallel() Definition: threadedentityiterator.hh:54 A simple class which makes sure that a timer gets stopped if an exception is thrown. Definition: timerguard.hh:42 ScalarBuffer * allocateManagedScalarBuffer(std::size_t numEntities) Allocate a managed buffer for a scalar field. Definition: vtkmultiwriter.hh:192 VTK output module for the fluid composition. Definition: vtkprimaryvarsmodule.hpp:48 static void registerParameters() Register all run-time parameters for the Vtk output module. Definition: vtkprimaryvarsmodule.hpp:74 Definition: alignedallocator.hh:97 Declare the properties used by the infrastructure code of the finite volume discretizations. Provides data handles for parallel communication which operate on DOFs. Declares the parameters for the black oil model. Definition: fvbaseprimaryvariables.hh:141 auto Get(bool errorIfNotRegistered=true) Retrieve a runtime parameter. Definition: parametersystem.hpp:187 Definition: blackoilmodel.hh:79 Definition: blackoilboundaryratevector.hh:39 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:233 std::string to_string(const ConvergenceReport::ReservoirFailure::Type t) Definition: fvbasediscretization.hh:2058 static void serializeOp(Serializer &serializer, SolutionType &solution) Definition: fvbasediscretization.hh:2060 Definition: fvbasediscretization.hh:272 GetPropType< TypeTag, Properties::GridView > GridView Definition: fvbasediscretization.hh:113 GetPropType< TypeTag, Properties::DofMapper > DofMapper Definition: fvbasediscretization.hh:112 The class which marks the border indices associated with the degrees of freedom on a process boundary... Definition: basicproperties.hh:125 The secondary variables of a boundary segment. Definition: fvbaseproperties.hh:143 GetPropType< TypeTag, Properties::RateVector > type Definition: fvbasediscretization.hh:160 Type of object for specifying boundary conditions. Definition: fvbaseproperties.hh:119 The secondary variables of a constraint degree of freedom. Definition: fvbaseproperties.hh:146 The class which represents a constraint degree of freedom. Definition: fvbaseproperties.hh:122 The part of the extensive quantities which is specific to the spatial discretization. Definition: fvbaseproperties.hh:160 The discretization specific part of the intensive quantities. Definition: fvbaseproperties.hh:136 The discretization specific part of the local residual. Definition: fvbaseproperties.hh:91 typename BaseDiscretization::BlockVectorWrapper type Definition: fvbasediscretization.hh:283 Definition: fvbaseproperties.hh:77 The secondary variables of all degrees of freedom in an element's stencil. Definition: fvbaseproperties.hh:140 Dune::BlockVector< GetPropType< TypeTag, Properties::EqVector > > type Definition: fvbasediscretization.hh:174 A vector of holding a quantity for each equation for each DOF of an element. Definition: fvbaseproperties.hh:112 Dune::MultipleCodimMultipleGeomTypeMapper< GetPropType< TypeTag, Properties::GridView > > type Definition: fvbasediscretization.hh:106 The mapper to find the global index of an element. Definition: fvbaseproperties.hh:213 Specify whether the some degrees of fredom can be constraint. Definition: fvbaseproperties.hh:199 Specify if experimental features should be enabled or not. Definition: fvbaseproperties.hh:241 Dune::FieldVector< GetPropType< TypeTag, Properties::Scalar >, getPropValue< TypeTag, Properties::NumEq >()> type Definition: fvbasediscretization.hh:143 A vector of holding a quantity for each equation (usually at a given spatial location) Definition: fvbaseproperties.hh:109 Specify whether the storage terms use extensive quantities or not. Definition: fvbaseproperties.hh:233 Dune::BlockVector< GetPropType< TypeTag, Properties::EqVector > > type Definition: fvbasediscretization.hh:181 Vector containing a quantity of for equation for each DOF of the whole grid. Definition: linalgproperties.hh:54 Calculates gradients of arbitrary quantities at flux integration points. Definition: fvbaseproperties.hh:152 The secondary variables within a sub-control volume. Definition: fvbaseproperties.hh:133 The class which linearizes the non-linear system of equations. Definition: newtonmethodproperties.hh:36 A vector of primary variables within a sub-control volume. Definition: fvbaseproperties.hh:130 GetPropType< TypeTag, Properties::EqVector > type Definition: fvbasediscretization.hh:153 Vector containing volumetric or areal rates of quantities. Definition: fvbaseproperties.hh:116 Dune::BlockVector< GetPropType< TypeTag, Properties::PrimaryVariables > > type Definition: fvbasediscretization.hh:195 Vector containing all primary variables of the grid. Definition: fvbaseproperties.hh:126 The history size required by the time discretization. Definition: fvbaseproperties.hh:225 a tag to mark properties as undefined Definition: propertysystem.hh:38 Definition: fvbaseproperties.hh:181 Specify whether to use volumetric residuals or not. Definition: fvbaseproperties.hh:237 Dune::MultipleCodimMultipleGeomTypeMapper< GetPropType< TypeTag, Properties::GridView > > type Definition: fvbasediscretization.hh:101 The mapper to find the global index of a vertex. Definition: fvbaseproperties.hh:207 Specify the format the VTK output is written to disk. Definition: fvbaseproperties.hh:195 |