this helps to keep the core blackoil model code lean and mean and it
is also less confusing for newbies because the ECL blackoil simulator
is not a "test" anymore.
in case somebody wonders, "ebos" stands for "&eWoms &Black-&Oil
&Simulator". I picked this name because it is short, a syllable, has
not been taken by anything else (as far as I know) and "descriptive"
names are rare for programs anyway: everyone who does not yet know
about 'git' or 'emacs' and tells me that based on their names they
must be a source-code managment system and an editor gets a crate of
beer sponsored by me!
This code is required in the first place because opm-material always
specifies all parameters in terms of the wetting saturations while the
gas is the non-wetting phase in a gas-oil system.
this does not disrupt the block nature of the linearized matrix
(i.e. Dune::BCRSMatrix is still used), but if the number of auxiliary
equations is smaller than that of the "main" discretization, the
superfluous equations are padded. if the number of additional
equations are larger than that of the equation, additional DOFs are
added.
the biggest change is that it is now based on a new approach: the well
model now always calculates the bottom hole pressure for the full well
when asked for a source term. This change makes it possible to
implement cross flow within wells properly and should also make the
well model physically correct.
Also, the well model now uses the connection transmissibility factor
which makes it possible to use this quantity if it is specified by the
deck...
the goal is to make it faster on computers with many cores: The
easiest way to do this is to ensure that the longest running tests are
not taking too much time and that they need about the same time. Thus
this patch contains the following changes which limits the CPU time
taken by each test to about two minutes in debug mode on my machine:
- the water-air problem using the non-isothermal primary variable
switching model now uses an 16x16 instead of a 32x32 grid. as a
compensation it now runs for a year instead of 5000 seconds and the
global grid refinement is now tested.
- the end time of the lens problem ctests is now 3000 instead of
30000 seconds. The binary itself does not change at all.
- sort the tests in the CMakeLists.txt roughly in the order of their
required time. (this will cause ctest not having to wait for long
running test which were started late for too long.)
it was used for debugging intersection mappers. to make this include
work, dune-cornerpoint must be available and that the intersection
mapper PR must be merged.
this means that all code which could potentially throw an exception is
moved to this method(). (In particular FluidSystem::init() proved
troublesome in the past.) Besides avoiding segmentation the faults
which stem from exceptions thrown in constructors, this also has the
advantage that simulations which spend a noticable amount of time to
initialize stop at the "correct" place, i.e. after the "Finish init of
the problem" message was printed by the simulator...
this regressed after time step index of the initial solution was
changed from 0 (actually, this was also 0 for the first time step...)
to -1 in b30af664.
this method checks that the difference in the storage terms before and
after a time step is the same as the accumulated fluxes over the
domain boundary plus the source terms.
... and actually use it for the lens problems. This seems to have been
disabled for debugging and later it was probably forgotten to turn it
on again. This led to some minor bit-rot in that code...
The reason for this is to be able to modify the tolerance according to
grid size: The NewtonTolerance parameter has been renamed to
NewtonRawTolerance and for the porous media models is divided by the
square root of the volume of the smallst finite volume in the grid to
get the final tolerance for the Newton method. This is necessary
because very large grids need to achive a higher volumetric accuracy
in the residual than very small ones...
basically the init() method was split into a finishInit() method which
fills the data structures allocated in the constructor with meaningful
data and into applyInitialSolution() which does just that (and no
more!)
"intensive" means that the value of these quantities at a given
spatial location does not depend on any value of the neighboring
intensive quantities. In contrast, "extensive" quantities depend in
the intensive quantities of the environment of the spatial location.
this change is necessary is because the previous nomenclature was very
specific to finite volume discretizations, but the models themselves
were already rather generic. (i.e., "volume variables" are the
intensive quantities of finite volume methods and "flux variables"
are the extensive ones.)
because "manager" sounds less religious than "creator" and the
GridCreators did all kinds of other stuff besides creating the grid.
this patch also gets rid of the static function inside these classes,
which should make them easier to understand...
this also comes with moving responsibilities around and some smaller
cleanups for the grid creation. (although grid creation could be
possibly done by the simulator now, the GridCreator concept has not
been abandoned, yet...)
These used to be needed to be enabled by the problem, but doing it in
the generic code is more fool proof and thus better.
On my laptop, volume variable caching caused the linearization time
for first time step of the isothermal vertex-centered CO2 injection
problem using the flash model go from 33.7 to 15.7 seconds, and
enabling thermodynamic hints in addition yielded a linearization time
of "only" 9.5 seconds. (that is for a debug build compiled with clang
3.3.)
this is implemented by extending the existing functionality for hints
and leads to a significant reduction of the volume variables updates
required. unfortunately, the performance with cached volume variables
is basically identical to the non-cached case, so they are disabled by
default...
anyway, this makes the thermodynamic hints code more robust and
cleaner, so it does not hurt to add it...
this allows to retrieve the name of the problem before it is
instantiated. this is required to be able to print the "Initializing
problem" message at the correct point (i.e., before instantiating the
problem).
and some other minor changes. (if you need line search the issue is
probably caused a different problem and line search would be just a
work-around anyway.)
This should make things a much more robust, partially because now the
linear and the non-linear solvers use the same convergence criterion.
Also, this patch includes some collateral indentation improvements.
This makes eWoms multi-discretization capable. Along the way, this
fixes some bugs and does a medium sized reorganization of the source tree.
This is a squashed patch of the following commits:
--------
1st commit message:
add initial version of the element centered finite volume discretization
currently, it is a misnomer as it is just a copy of the vertex
centered discretization plus some renames...
--------
2nd commit message:
rename [VE]cfvModel -> [VE]cfvDiscretization
--------
3rd commit message:
ecfv: prelimary changes required to make it compile
but not work yet...
--------
4th commit message:
Rename *FvElementGeometry to *Stencil
"Stencil" seems to be the standard expression for this concept...
(also, it is not specific to finite volume methods and is shorter.)
--------
5th commit message:
refactor the stencil class for the element centered finite volume discretization
--------
6th commit message:
ECFV: some work on the stencil class
--------
7th commit message:
ECFV: make the boundary handling code compile
--------
8th commit message:
rename elemContext() to elementContext()
--------
9th commit message:
ECFV: make the VTK output modules compile
--------
10th commit message:
stencil: introduce the concept of primary DOFs
also save an vector of all element pointers in the stencil.
--------
11th commit message:
ECFV: try to fix assembly; add missing timeIdx arguments to the num*() methods
--------
12th commit message:
ECFV: fix stupid mistake in the assembler
--------
13th commit message:
ECFV: remove a few implicit DOF == vertex assumptions
the black-oil example now runs without valgrind complaints until it encounters
a negative oil mole fraction.
--------
14th commit message:
VCFV: make everything compile again
all vertex centered FV examples should now work again...
--------
15th commit message:
rename [ev]cfvmodel.hh to [ev]cfvdiscretization.hh
the classes have already been renamed.
--------
16th commit message:
ECFV: make it work to the point where it can write out the initial solution.
--------
17th commit message:
ECFV: make it work
the local residual/jacobian needed some work in distinguishing primary
and secondary DOFs and there was an minor issue with the serialization
code.
for some reason, it seems still not correct. (-> convergence is too slow.)
--------
18th commit message:
VCFV: make it compile for the black oil model again
--------
19th commit message:
VCFV: make it compile with the remaining models again
--------
20th commit message:
flash model: make it work with ECFV
although this breaks its compatibility with VCFV. (-> next commit)
--------
21st commit message:
adapt the VCFV to make it compatible with the flash model again
--------
22nd commit message:
make all models compile with VCFV again
--------
23rd commit message:
VCFV: more cleanups of the stencil
VcfvStencil now does not have any public attributes anymore. TODO: do
not export attributes in the SubControlVolume and SubControlVolumeFace
classes.
--------
24th commit message:
VCFV: actually update the element pointer
--------
25th commit message:
change the blackoil model back to ECFV
--------
26th commit message:
immiscible model: make it compatible with the ECFV discretization
--------
27th commit message:
PVS model: make it work with ECFV
--------
28th commit message:
NCP model: make it work with ECFV
--------
29th commit message:
rename Vcfv*VelocityModule to *VelocityModule
--------
30th commit message:
richards model: make it work with ECFV
--------
31st commit message:
unify the ECFV and the VCFV VTK output modules
and other cleanups
--------
32nd commit message:
unify the common code of the VCFV and the ECFV disctretizations
--------
33rd commit message:
unify the element contexts between element and vertex centered finite volumes
--------
34th commit message:
unify the local jacobian class of the finite volume discretizations
--------
35th commit message:
replace [VE]vcf(LocalResidual|ElementContext|BoundaryContext|ConstraintsContext) by generic code
--------
36th commit message:
replace the [EV]cfvLocalResidual by generic code
--------
37th commit message:
unify the MultiPhaseProblem and Problem classes, introduce NullBorderListCreator
--------
38th commit message:
remove the discretization specific boundary context
--------
39th commit message:
unify the [EV]cfvDiscretization classes
--------
40th commit message:
Unify [EV]cfvMultiPhaseFluxVariables
--------
41st commit message:
Unify the [EC]cfvNewton* classes
--------
42nd commit message:
Unify [EV]cfvVolumeVariables
--------
43rd commit message:
unify [EV]cfvAssembler
--------
44th commit message:
unified flux variables: fix stupid mistake when calculating pressure gradients
--------
45th commit message:
unify what's to unify for the [EV]CFV properties
--------
46th commit message:
make the method to calculate gradients and values at flux approximation points changeable
Currently, this is used by the vertex centered finite volume method to
be able to use P1-finite element gradients instead of two-point
ones...
--------
47th commit message:
make the restart code work correctly, use the correct DofMapper for VCFV
--------
48th commit message:
actually use the gradient calculator in a model
the immiscible model in this case
--------
49th commit message:
move some files around to where they belong, use the new gradient calculation code in all models
TODO: proper handling of boundary gradients
--------
50th commit message:
fix the stokes model
currently it only works with the vertex centered finite volume
discretization, but the plan is to soon move it to a staggered grid
scheme anyway...
--------
51st commit message:
move all models back to using the vertex centered finite volume discretization by default
--------
52nd commit message:
models: some variable renames and documentation fixes
- scv -> dof
- vert -> dof
- vertex -> dof
- replace 'VCFV'
- fix some typos
--------
53rd commit message:
don't expect UG anymore
since it is quite non-free and hard to get. we now use ALUGrid instead!
--------
54th commit message:
temporarily disable jacobian recycling
--------
55th commit message:
fix writing/reading restart files using the generic code
--------
56th commit message:
fix bug where fluxes were only counted once in the stencil
this only affected the vertex centered finite volumes discretization...
--------
57th commit message:
boundary gradients: use the center of the sub-control volume adjacent to a boundary segment
--------
58th commit message:
make it compile on GCC
--------
59th commit message:
get rid of most hacks
for this, partial reassemble and jacobian recycling was brought
back. For the this and the remaining stuff the main trick is the
introduction of the GridCommHandleFactory concept which constructs
communication handles suited for the respective spatial
discretization...
--------
60th commit message:
fix a few annoying bugs
first, default the convergence criterion for the linear solver did not
honor the initial residual which lead to linear solver breakdowns,
then some debugging code was left in the discrete fracture model and
then there was a bug in the TP gradient approximation class...
this has the consequence that we need a new reference solution for the
discrete fracture problem...
--------
61st commit message:
iterative linear solver: remove the code for the non-default convergence criteria
--------
62nd commit message:
provide the FE cache instead of the local FE
this fixes a segfault in the stokes model caused by the fact that the
local FE was not initialized at this point.
--------
63rd commit message:
(Navier-)Stokes: fix bug due to the transition to unit normals
now, all tests pass for this branch. The only things which need to be
fixed are some annoying performance regressions compared to master and
some bug in the splices feature of the property system...
--------
64th commit message:
some fix for the local residual of the immiscible model
--------
65th commit message:
Navier-Stokes: implement SCV center gradients
There seems to be a bug in the previous implementation (the jacobian
inverse transposed is evaluated using the local, not the global
geometry), so the reference solution for the stokes2c test problem has
also been updated...
--------
66th commit message:
remove the ALUGrid specialization of the LensGridCreator and the YaspGrid one for the fingerproblem
using different grid seems to sometimes cause a different vertex
order, which in turn causes the respective test to fail if the
reference solution was computed using the other grid...
--------
67th commit message:
VCFV: use the correct BorderListCreator
this makes MPI parallel computations work again. apart from
performance regressions, this branch does not exhibit any known
regressions compared to master anymore...
--------
68th commit message:
make verything compile with the element centered finite volume discretization
except the Navier-Stokes and the two-phase DFM models, of course...
--------
69th commit message:
minor fixes
- make the navier-stokes model slighly more generic by using the
proper (in,ex)teriorIndex() methods on sub-control volumes
- make the signature of the calculateValue() template method of the
common two-point gradient approximator match the one of the vertex
centered finite volume one
--------
70th commit message:
fix fallout from the Big Rebase
--------
71st commit message:
ECFV: some bugs in the boundary
--------
72nd commit message:
make computeFlux() compute area-specific quantities
--------
73rd commit message:
fix more bugs in the element centered FV discretization
now eWoms should match Dumux pretty closely...
--------
74th commit message:
coalesce the common code of the multi phase porous medium models into "MultiPhaseBaseModel"
--------
75th commit message:
update reference solutions
these were changed because of the screw-up with the area of boundary
segments...
--------
76th commit message:
rename "ImplicitBase" to "FvBase"
because in eWoms, everything is implicit and these are currently the
base classes for all finite volume discretizations.
--------
77th commit message:
make the spatial discretization selectable using a splice
This requires an opm-core with a the patches from
https://github.com/OPM/opm-core/pull/446 merged...
--------
78th commit message:
rename the properties used for splices to *Splice
--------
79th commit message:
move the files in 'tests/models' to 'tests'
since 'tests' was empty except for the 'models' subdirectory...
--------
80th commit message:
improve and fix the tutorial
--------
81st commit message:
remove the -fno-strict-aliasing flag from the provided option files
seems like recent versions of Dune have been adapted...
--------
82nd commit message:
also compile all CO2 injection simulations using the element centered finite volume discretization
--------
83rd commit message:
PVS model: make it work properly with the element-centered finite volume discretiation
because DOF != number of vertices
we do not have a decoupled tutorial anymore since, well, the decoupled
models have been removed. Also since the move to the Opm CMake based
build system, the "How to create a new folder" section in the handbook
was obsolete.
Only public member names have been treated so far. Local variables
will be done shortly, classes maybe not before the next release
cycle. Everything old could be marked deprecated.
Reviewed by Benjamin and Christoph.
Dumux-Svn-Revison: 10761
Ported-By: Andreas Lauser <andreas.lauser@iws.uni-stuttgart.de>
- special status of saturation. In particular, it deals with the
capitalized "S"-indices:
S0Idx -> s0Idx
SnIdx -> snIdx
SwIdx -> swIdx
SOrX1Idx -> sOrX1Idx
SOrX2Idx -> sOrX2Idx
SnOrXidx -> snOrXIdx
SwOrXIdx -> swOrXIdx
Reviewed by Christoph.
Dumux-Svn-Revison: 10756
Ported-By: Andreas Lauser <andreas.lauser@iws.uni-stuttgart.de>
- time steps for the pressure model can be choosen larger than for the
transport model
- locally small time steps of the std::explicit scheme are less
restrictive
- reviewed by Bernd
Dumux-Svn-Revison: 10700
Ported-By: Andreas Lauser <andreas.lauser@iws.uni-stuttgart.de>
- it now can generate and install the API documentation ('make install-html')
- the information of the dune.module file is now used much more extensively
- presence of the valgrind headers is tested
- tests which cannot be run for a configuration will now appear as
'skipped' in CDash
- adding tests does not require modifying the toplevel CMakeList.txt anymore
- introduction of the 'EwomsAddTest' cmake macro which removes quite a bit of the
copy-and-paste from the CMakeLists.txt.
- various small loose ends have been fixed
this is somewhat similar to what is currently done in the 'implicit'
branch of dumux, but it takes things further:
- ewoms/boxmodels/common -> ewoms/disc/vcfv
(vcfv == vertex centered finite volumes)
- ewoms/boxmodels/vtk -> ewoms/vtk
(possibly this will move to ewoms/io/vtk, TBD)
- ewoms/boxmodels -> ewoms/models
- test/boxmodels -> test/implicit
- the files for the common VCFV code have been renamed from "box*" to
"vcfv\1" and the classes they contain have been renamed accordingly.
The rationale is to reflect the fact that multiple discretizations may
be chosen for any physical model. (Once these discretizations are
implemented, obviously.) All tests still compile for the autotools and
cmake build systems
instead of typing 'make test/common/propertysystem/test_propertysystem'
in the toplevel build directory, one can now just type
'make test_propertysystem'
eWoms hereby declares full independence. Humor aside, the main
technical advantage of this is, that it is now possible to easily
install both, Dumux and eWoms on a system using a package management
system without bad tricks.
in addition to last time, don't add authors that are responsible than
5 lines in a file. This mainly makes a difference for very short files
like the .cc files...
finally, the documentation builds without any warnings from
doxygen. This does not mean that the documentation is correct, though:
Quite a bit of prose is still required for the model and problem
descriptions...
"runtime" parameters are gone now, as are groups. both where flawed
concepts: parameters can be overwritten at runtime by definition, and
a parameter that has no compile-time fallback just degrades
performance and is a hassle to deal with because it has to be
specified in a parameter file. The other killed feature, parameter
groups, just made it harder to figure out what the correct command
line argument was to change the parameter (was it
--linear.solver-tolerance, --linear-solver.tolerance or
--linear-solver-tolerance?) and did not provide much value otherwise.
as a consequence all parameters now have compile-time defaults which
allows us to remove the auto-loading of a parameter file at
startup. (These files became quite obnoxious in eWoms when problems
declared their independence from models.)
Finally all parameters must now be registered before they can be used
which allows to properly include them in the usage message.
this time we ignore the commits 024955b5, f34d3482, 292c0084,
153374e8, 54c9450f, 6bc12abc, ee0eb46b, a1f3edc6, 5858986f and
0c4b9162 because these are huge commits that either dealt with white
space clean ups or just moved some files around. Also for the total
lines in a source file we only account for the non-ignored lines.
This time hopfully for good. There were a few bugs in the script to
update them, and the metric was slightly chanted: Now, only authors
that contributed more than 5% of the lines of a file are listed. We
now also properly ignore the copyright headers and the changes made in
commit 024955b5 as the latter just moved a lot of files around.
while the git history might be not entirely accurate, it is certainly
much better what is currently there. the authors are sorted by the
number of lines changed in the file.
- the prefix "simple" should only be used if a more complex version of
the same component is available
- deprecated Oil and SimpleDNAPL
approved by coffee break
Dumux-Svn-Revison: 8943
Ported-By: Andreas Lauser <andreas.lauser@iws.uni-stuttgart.de>
this hopefully reduces confusion about what which parameter means. the
Domain* parameters specify the physical size of the simulated domain,
the Cells* specify how many cells the grid has into the direction of
each axis.
the immiscible(ni) model is a model that is independent on the number
of phases and assumes immiscibility. this change is along the lines of
the previous commit for the compositional primary variable switching
model.
to make them self-descriptive and consistent with the other parameters
and properties "TEnd" is renamed to "EndTime" and "DtInitial" to
"InitialTimeStepSize".
Tensor -> DimMatrix
refElem -> refElement
gv -> gridView
remove "AtIP" suffix
*Index -> *Idx for variables
remove ${MODEL_NAME}Index property
consistent argument names for compute(Storage|Flux|Source) in the local residuals
also remove the "MassUpwindWeight" and "UpwindWeight" properties as
they were not really useful.
I also removed the deprecation stuff, as IMO it is more confusing than
helpful. (Ever tried to set the
SpatialParameters instead of SpatialParams in your problem?)
Also move the decoupled spatial parameters from dumux/material to
dumux/decoupled because they are specific to the decoupled models.
most includes are now sorted by abstraction levels, with the most
abstract header first. also some system headers like <string> are now
explicitly included in every file where some of their classes are
used.
the switches are the introduction of "smart primary variables", rate
vectors, and changing the capillary pressure API for the multi-phase
models to the one previously used by the MpNc model.
- this renames historyIdx to timeIdx (I think it expresses what it is meant for better)
- rename localIdx to "spaceIdx" in the problems/spatial parameters
- add a "timeIdx" argument to the problem's methods
since this was done in a semi-automatic way compilation for stuff not
used by the non-decoupled tests may be non-functional. I spared the
decoupled stuff because it does not compile ATM so I did not have a
way verify that it still works...
tested on GCC 4.3 and GCC 4.6. Due to an incompatibility between those
two compilers (GCC 4.3 expects that there's no semicolon behind
static_assert(), GCC 4.6 requires one), it only compiles on GCC 4.6.
- the constructor of VtkMultiWriter now expects a grid view as first
argument. unfortunately the old API cannot be kept around with this
change.
- as a follow up beginWrite() does not need the grid view as an
argument anymore
- if the grid has been changed during two time steps, the new method
gridChanged() must be called before beginWrite() is called
