User Guide¶
The User Guide provides detailed documentation for every major subsystem in BORES. Each page covers one topic in depth, with working code examples, parameter references, and practical guidance.
Sections¶
| Section | Description |
|---|---|
| Grids | Grid construction utilities: uniform, layered, depth, structural dip, and saturation grids |
| Rock Properties | Porosity, permeability (isotropic and anisotropic), and rock compressibility |
| Fluid Properties | PVT correlations, oil/gas/water properties, and the reservoir model factory |
| Relative Permeability | Brooks-Corey model, Corey exponents, wettability, and three-phase mixing rules |
| Capillary Pressure | Brooks-Corey, Van Genuchten, Leverett J-function, and tabular capillary pressure |
| Wells | |
| Well Basics | Production and injection wells, perforations, well index, skin factor |
| Well Controls | Rate controls, BHP controls, CoupledRateControl, MultiPhaseRateControl |
| Well Fluids | Produced fluids, injected fluids, CO2 property overrides |
| Well Schedules | Time-dependent well events, predicates, and actions |
| Well Patterns | Common well placement patterns for waterfloods and EOR |
| Simulation | |
| Time Stepping | Timer class, adaptive control, CFL conditions, ramp-up |
| Solvers | Pressure solvers, preconditioners, CachedPreconditionerFactory |
| Streaming and Storage | StateStream, storage backends, replay |
| Advanced | |
| Boundary Conditions | No-flow, constant pressure, periodic, Carter-Tracy aquifer |
| Faults and Fractures | Transmissibility modifiers, fault definitions |
| PVT Tables | Tabular PVT as alternative to correlations |
| Simulation Analysis | Analysis utilities, recovery factors, production profiles |
| Serialization | Saving/loading models, custom type registration |
| Miscible Flooding | Todd-Longstaff model, MMP, mixing parameter |
| Configuration | Complete Config class reference |
| Constants | Physical constants and the Constants class |
Where to Start
If you completed the Tutorials, start with the sections most relevant to your current project. The sections on wells, relative permeability, and simulation controls are the most commonly referenced.