Skip to content

Commit 5f7e350

Browse files
committed
Replace Eclipse trademark references and add third-party trademark notices
- Replace generic "Eclipse" usage with neutral terms ("reservoir simulation case/file/properties/grid") across 34 content files, preserving UI labels and menu item names that reflect the actual software interface - Add trademark table to about.md for Eclipse® (Schlumberger), ABAQUS® (Dassault Systèmes), SourSimRL (ESSS), StimPlan™ (NSI Technologies LLC), Fishbones® (Fishbones AS), and GNU Octave (John W. Eaton) - Add first-mention trademark symbols (®/™) for StimPlan and Fishbones across relevant content pages - Update docs-writer agent with trademark guidance, simulation type distinction (reservoir vs geomechanical), and terminology table
1 parent d5e2414 commit 5f7e350

34 files changed

+130
-96
lines changed

agents/docs-writer.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,36 @@ Use Hugo shortcodes for internal links — never hardcode paths:
4545
- Use `---` horizontal rules to separate major wizard page sections.
4646
- Do not use emoji.
4747

48+
## Simulation types
49+
50+
ResInsight supports two distinct simulation types. Use precise language to distinguish them:
51+
52+
- **Reservoir simulation** — results from simulators such as the *Eclipse® reservoir simulator* or OPM Flow. Stored in `.EGRID`/`.GRID`, `.UNRST`, `.SMSPEC` files etc.
53+
- **Geomechanical simulation** — results from ABAQUS, stored in `.odb` files.
54+
55+
When the context is unambiguous (e.g. a page dedicated to reservoir simulation), "simulation" alone is acceptable. When both types could be in scope, be explicit: "reservoir simulation" or "geomechanical simulation".
56+
57+
Never use bare "simulation" in a way that could be misread as covering both types.
58+
4859
## Terminology
4960

5061
| Avoid | Use instead |
5162
|-------|-------------|
52-
| Eclipse grid | simulation model / grid |
63+
| Eclipse grid | reservoir model / grid |
5364
| Eclipse DATA file | DATA file |
54-
| Eclipse case | simulation case |
55-
| Eclipse file | simulation file / grid file |
56-
| Eclipse results | simulation results |
65+
| Eclipse case | reservoir simulation case |
66+
| Eclipse file | reservoir simulation file / grid file |
67+
| Eclipse results | reservoir simulation results |
68+
| Eclipse simulation | reservoir simulation |
5769

5870
When the Eclipse product name cannot be avoided, use *Eclipse® reservoir simulator* on first mention per page and *Eclipse simulator* on subsequent mentions.
71+
72+
Other third-party trademarks used in the documentation:
73+
74+
| Product | Trademark owner | First-mention form |
75+
|---------|----------------|--------------------|
76+
| ABAQUS | Dassault Systèmes | *ABAQUS®* |
77+
| SourSimRL | ESSS | *SourSimRL* (no symbol — unregistered trademark) |
78+
| StimPlan | NSI Technologies, LLC | *StimPlan™* |
79+
| Fishbones | Fishbones AS | *Fishbones®* (registered trademark, Norwegian Patent Office no. 268831) |
80+
| GNU Octave | John W. Eaton and contributors | *GNU Octave* (no symbol — free software, GPL) |

content/3d-main-window/3DViews.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Each item has a set of properties that can be edited in the **Property Editor**.
1414

1515
Several views can be added to the same case by right-clicking the case or a view and select **New View**. You can also **Copy** and then **Paste** a view into a Case. All the settings are then copied to the new view.
1616

17-
Views of Eclipse models and Geomechanical models has a lot in common, but Eclipse views has some features that applies to Eclipse simulations only.
17+
Views of Eclipse models and Geomechanical models has a lot in common, but Eclipse views has some features that applies to reservoir simulations only.
1818

1919
## Common view features
2020

@@ -34,7 +34,7 @@ Zoom and orientation of a model can be stored using the menu item **"Views->Stor
3434

3535
### Cell Result
3636

37-
The **Cell Result** {{< image-in-text src="images/3d-main-window/CellResult.png" >}} item defines which Eclipse or Geomechanical property the 3D View uses for the main cell color. The property can be chosen in the property panel of the **Cell Result** item. The mapping between cell values and color is defined by the **Legend Definition**{{< image-in-text src="images/3d-main-window/Legend.png" >}} along with some appearance settings on the Legend itself. (Number format etc.)
37+
The **Cell Result** {{< image-in-text src="images/3d-main-window/CellResult.png" >}} item defines which simulation or Geomechanical property the 3D View uses for the main cell color. The property can be chosen in the property panel of the **Cell Result** item. The mapping between cell values and color is defined by the **Legend Definition**{{< image-in-text src="images/3d-main-window/Legend.png" >}} along with some appearance settings on the Legend itself. (Number format etc.)
3838

3939
Please refer to [Result Color Legend]({{% relref "resultcolorlegend" %}}) for details.
4040

@@ -114,7 +114,7 @@ Select **Custom Edge Result** to specify one cell result to be mapped onto all c
114114
Default result mapping on faults is using the result specified in **Cell Result**. If a different result mapping is wanted, enable the checkbox and select the result from the result selection dialog in the **Property Editor**. A second legend for the fault result is added to the view.
115115

116116
### Simulation Wells
117-
This item controls the visualization of the Eclipse simulation wells.
117+
This item controls the visualization of the simulation wells.
118118
Please refer to [Simulation Wells]({{% relref "simulationwells" %}}) to read more.
119119

120120
### Well Connection Factors

content/3d-main-window/CellResults.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ Results and difference options are displayed by the Property Editor.
2929

3030
The different result types are:
3131

32-
- **Dynamic** -- Time varying properties of an Eclipse simulation and derived properties calculated by ResInsight, c.f.
32+
- **Dynamic** -- Time varying properties of a simulation and derived properties calculated by ResInsight, c.f.
3333
[Derived Results]({{% relref "derivedresults" %}})
34-
- **Static** -- Eclipse properties that does not vary with time and derived properties calculated by ResInsight, c.f. [Derived Results]({{% relref "derivedresults" %}})
34+
- **Static** -- Properties that do not vary with time and derived properties calculated by ResInsight, c.f. [Derived Results]({{% relref "derivedresults" %}})
3535
- **SourSimRL** -- Available if SourSimRL results have been imported, c.f. [SourSimRL Import]({{% ref "soursimrlresults.md" %}})
3636
- **Generated** -- Results generated by an Octave Script
37-
- **Input Property** -- Directly imported Eclipse properties from ascii files
37+
- **Input Property** -- Directly imported reservoir simulation properties from ascii files
3838
- **Formation Names** -- Lists only the Active Formation Names selected on the case, c.f. [Formations]({{% ref "formations.md" %}})
3939
- **Flow Diagnostics** -- Flow diagnostic results derived from a flux field,
4040
c.f. [below]({{% relref "cellresults" %}}#flow-diagnostic-results)
@@ -65,7 +65,7 @@ See also [ Flow Diagnostics Plots]({{% relref "flow-diagnostics-plots" %}}) and
6565

6666
The calculations are performed by a library called [opm-flowdiagnostics](https://github.com/OPM/opm-flowdiagnostics) developed by [SINTEF Digital](http://www.sintef.no/sintef-ikt/#/).
6767

68-
This method is based on the presence of a flux field, and will use the flux field written to the Eclipse result data file (Cell Properties: FLRGAS, FLRWAT, FLROIL) if available. If these are not available, the flux field is estimated by algorithms in the opm-flowdiagnostics-applications library based on pressure differences, relative and absolute permeability and viscosity. Other effects are not included.
68+
This method is based on the presence of a flux field, and will use the flux field written to the result data file (Cell Properties: FLRGAS, FLRWAT, FLROIL) if available. If these are not available, the flux field is estimated by algorithms in the opm-flowdiagnostics-applications library based on pressure differences, relative and absolute permeability and viscosity. Other effects are not included.
6969

7070
A more elaborate description of the technique and how it can be utilized, can be found at Sintef's [web site](http://www.sintef.no/projectweb/mrst/modules/diagnostics/). The MRST tool described is a Matlab predecessor of the flow diagnostics calculations developed for ResInsight.
7171

@@ -123,7 +123,7 @@ This result type is used to plot derived results based on a selection of simulat
123123

124124
![](/images/3d-main-window/InjectionFloodingPropertyPanel.png)
125125

126-
- **Tracers** -- Lists the available simulation tracers from the Eclipse Case. The list is produced by showing only the properties with names ending with the letter "F". Select the tracers you want to investigate.
126+
- **Tracers** -- Lists the available reservoir simulation tracers from the reservoir simulation case. The list is produced by showing only the properties with names ending with the letter "F". Select the tracers you want to investigate.
127127
- **Result Property** -- Select the variable you want to calculate. (_Number Of Flooded PV_ is currently the only one)
128128

129129
## Geomechanical Results

content/3d-main-window/ComparisonView.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Comparison View allows comparison of information of different grids and diff
1111
This improves efficiency and simplifies the workflow when working with related but different models.
1212

1313
The figure above exemplifies a Comparison View for comparison of two different simulations models and results.
14-
The left hand side is used to display grid and results of an [Eclipse simulation]({{% relref "eclipsecases" %}})
14+
The left hand side is used to display grid and results of a [reservoir simulation]({{% relref "eclipsecases" %}})
1515
while the right hand side displays an ABAQUS grid and simulation results from [geomechanical analysis]({{% relref "geomechanicaldata" %}}).
1616

1717
A different way to use the Comparison View is to compare the same geometrical grid with different [Cell Results]({{% relref "cellresults" %}}).

content/3d-main-window/ContourMaps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight = 40
66

77
![](/images/3d-main-window/ContourMaps.png)
88

9-
ResInsight can create contour maps based on different forms of aggregation of 3D Eclipse data onto a 2D Plane. Any 3D result value can be aggregated, in addition to specialised results, such as Oil, Gas and Hydrocarbon columns. A Contour Map is a specialised 2D view with many of the same features as the 3D views, including property filters, range filters and display of faults and wells.
9+
ResInsight can create contour maps based on different forms of aggregation of 3D reservoir simulation data onto a 2D Plane. Any 3D result value can be aggregated, in addition to specialised results, such as Oil, Gas and Hydrocarbon columns. A Contour Map is a specialised 2D view with many of the same features as the 3D views, including property filters, range filters and display of faults and wells.
1010
ResInsight is able to [export a contour map]({{% relref "contourmapexport" %}}) to a text file.
1111

1212
Polygons can be created from visible areas. If you want to compute contour maps for ensembles, look at [Ensemble Contour Map]({{% relref "ensemblecontourmap" %}})
@@ -16,7 +16,7 @@ Polygons can be created from visible areas. If you want to compute contour maps
1616
Contour Maps can be created in many different ways:
1717

1818
- New Contour Map from the right-click menu of case or the **Contour Maps** project tree item underneath the case. These will create contour maps with default values.
19-
- New Contour Map from 3D View in the Eclipse View right-click menu. This will create a contour map based on the existing 3D View with matching filters and result.
19+
- New Contour Map from 3D View in the simulation View right-click menu. This will create a contour map based on the existing 3D View with matching filters and result.
2020
- Duplicate Contour Map from the right-click menu of an existing Contour Map. This will copy the existing map.
2121

2222
![](/images/3d-main-window/NewContourMapFromCase.png) ![](/images/3d-main-window/NewContourMapFromFolder.png)

content/3d-main-window/EnsembleContourMap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight = 40
55

66
![](/images/3d-main-window/ensemble-grid-contour-map.png)
77

8-
ResInsight can create contour maps from an ensemble of grid models based on different forms of aggregation of 3D Eclipse data onto a 2D plane.
8+
ResInsight can create contour maps from an ensemble of grid models based on different forms of aggregation of 3D reservoir simulation data onto a 2D plane.
99

1010
[Video Tutorial: Ensemble Contour Map](https://youtu.be/qE_PeNx3xP0?si=tSmzJhmmAtENsiYN)
1111

content/3d-main-window/Faults.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ As import of faults can be time consuming, reading of faults can be disabled fro
3838
{{% /notice %}}
3939

4040
#### NNC Data
41-
If enabled in **Preferences**, ResInsight will read Non Neighbor Connections from the Eclipse output file (_`*.INIT`_), and create explicit visualizations of those.
41+
If enabled in **Preferences**, ResInsight will read Non Neighbor Connections from the simulator output file (_`*.INIT`_), and create explicit visualizations of those.
4242
The NNC's are sorted onto the Fault's and their visibility is controlled along with them.
4343

4444
When the NNCs are imported from file, ResInsight will identify NNCs not defined in the input file (Faces with zero transmissibility is not exported from the simulator). See [Derived Results]({{% relref "derivedresults" %}}) for details on other NNC related results.
@@ -96,7 +96,7 @@ First of all, these options are only available in **Faults-only** visualization
9696

9797
Secondly, the option you would normally want to adjust is **Dynamic Face Selection** ( See below ).
9898

99-
- **Show defined faces** -- Displays the fault cell faces that are defined on the Eclipse input file (_`*.DATA`_)
99+
- **Show defined faces** -- Displays the fault cell faces that are defined on the input file (_`*.DATA`_)
100100
- **Show opposite faces** -- Displays the opposite fault cell faces from what is defined on the input file, based on IJK neighbors.
101101
*These two options should normally be left **On**. They are useful when investigating the exact faults information provided on the `*.DATA` file. If you need to use them, it is normally wise to set the **Dynamic Face Selection** to "Show Both".*
102102
- **Dynamic Face Selection** -- At one particular position on a fault there are usually two cells competing for your attention: The cell closer to you as the viewer, or the one further from you. When showing results, this becomes important because these two cell faces have different result property values, and thus color.
@@ -114,7 +114,7 @@ The color of the NNC faces are set to be a bit lighter than their corresponding
114114

115115
## Fault Export
116116

117-
Faults can be exported to separate files in the _`*grdecl`_ file format. This is useful for example if you need a list of the geometrically detected faults that has not been covered by entries in the eclipse FAULTS keyword.
117+
Faults can be exported to separate files in the _`*grdecl`_ file format. This is useful for example if you need a list of the geometrically detected faults that has not been covered by entries in the FAULTS keyword.
118118

119119
To export some faults, select the faults you want to export in the **Project Tree**, and select the command **Export Faults ...** from the right-click menu.
120120

content/3d-main-window/FlowVectorResult.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ weight = 141
99
Flow Results lets the user investigate flow properties and fluxes in a reservoir, e.g. by flow vector visualizations selecting and combining different fluids and directions.
1010

1111
## Flow Vectors
12-
Flow vectors are computed based on the Eclipse properties **FLRGASI/J/K FLRWATI/J/K FLROILI/J/K**.
12+
Flow vectors are computed based on the reservoir simulation properties **FLRGASI/J/K FLRWATI/J/K FLROILI/J/K**.
1313
Visualization of flow vector results always use velocity instead of rate. Velocity is computed as flow rate divided by cell face area.
1414

1515
In order to show flow vectors, check the checkbox next to **Flow Vector Result** in **Project Tree**.
@@ -58,5 +58,5 @@ For instance, the option enables comparison of horizontal and vertical flow velo
5858

5959
![](/images/3d-main-window/FlowRateCellResultAndLegend.png)
6060

61-
Specifically, the check-box *Divide By Area* is applicable to Eclipse properties *FLROIL, FLRGAS, FLRWAT, FLOOIL, FLOGAS, FLOWAT*, and transmissibilities *TRAN* and *riTRAN*.
61+
Specifically, the check-box *Divide By Area* is applicable to reservoir simulation properties *FLROIL, FLRGAS, FLRWAT, FLOOIL, FLOGAS, FLOWAT*, and transmissibilities *TRAN* and *riTRAN*.
6262
These results are listed in ResInsight postfixed by *IJK+-* or *XYZ* as shown above. As seen, checking *Divide By Area* is reflected by text */A* in legend.

content/3d-main-window/Intersections.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,10 +189,10 @@ To select a simulation result to display on an intersection, right-click **Inter
189189

190190
![](/images/3d-main-window/SeparateIntersectionResults.png)
191191

192-
By selecting a specific **Intersection Result**, the **Property Editor** allows to specify case, type or position etc depending on whether the result stem from an Eclipse case or a Geomechanical case.
192+
By selecting a specific **Intersection Result**, the **Property Editor** allows to specify case, type or position etc depending on whether the result stems from a reservoir simulation case or a Geomechanical case.
193193

194194
The next step is to select an **Intersection** in **Project Tree** and define **Result Reference**.
195-
In the example below, available sources are the two **Intersections Results** of previous figure, one of which stems from a geomechanical case and the other from an Eclipse case.
195+
In the example below, available sources are the two **Intersections Results** of previous figure, one of which stems from a geomechanical case and the other from a reservoir simulation case.
196196

197197
![](/images/3d-main-window/IntersectionSeparateResultReference.png)
198198

content/3d-main-window/LinkedViews.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ When selecting a linked view in the project tree, the different options are avai
3434

3535
#### Link Cell Filters
3636

37-
- **Range Filters** -- Range filters in master view will be applied to all dependent views where this option is active. Normally this is done by a direct copy, but if the master and dependent view is of different types (Eclipse and Geomechanical views) and the Eclipse case is within the bounds of the Geomechanical case, ResInsight tries to map the range filters to the corresponding cells in the other case.
37+
- **Range Filters** -- Range filters in master view will be applied to all dependent views where this option is active. Normally this is done by a direct copy, but if the master and dependent view is of different types (Eclipse and Geomechanical views) and the reservoir simulation case is within the bounds of the Geomechanical case, ResInsight tries to map the range filters to the corresponding cells in the other case.
3838
- **Property Filters** -- Property filters in master view will be applied to all dependent views where this option is active.
3939

4040
## Toggle Linking from the **Project Tree**

0 commit comments

Comments
 (0)