Skip to content

Commit a055bca

Browse files
authored
Merge branch 'openrails:master' into blueprint/TrainCarOperations-ui-window
2 parents 356b543 + ef6c1a8 commit a055bca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+9130
-7592
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,4 +365,5 @@ ASALocalRun/
365365
healthchecksdb
366366

367367
# Backup folder for Package Reference Convert tool in Visual Studio 2017
368-
MigrationBackup/
368+
MigrationBackup/
369+
/Source/RunActivity/Properties/launchSettings.json

Docs/Architecture.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,22 @@ The threading in Open Rails has two key threads working together (Render and Upd
2929
- Web Server process
3030
- Handle all web and API requests
3131

32+
## Projects, assemblies, namespaces
33+
34+
Open Rails is made up of several component projects which are organised into subdirectories with the following naming pattern:
35+
36+
- `Orts.Component\Orts.Component.csproj` (project file)
37+
- `Orts.Component.dll` (assembly name)
38+
- `Orts.Component` (default namespace)
39+
40+
The namespaces used within code files should match the directory structure like this:
41+
42+
| *Filename* | *Namespace*
43+
|---|---|
44+
| `Orts.Component\File.cs` | `Orts.Component` |
45+
| `Orts.Component\Section\File.cs` | `Orts.Component.Section` |
46+
| `Orts.Component\Section\Subsection\File.cs` | `Orts.Component.Section.Subsection` |
47+
3248
## Simulator object relationships
3349

3450
This tree is a summary of the important object relationships (aggregation) inside the simulation. Each entry is a class whose instances can be accessed from the parent item.

Docs/Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Open Rails is a free train simulator supporting the world's largest range of dig
1010
## Documentation
1111

1212
* [Read the FAQ](http://www.openrails.org/learn/faq/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
13-
* [Read the manual online](https://open-rails.readthedocs.io/en/1.3.1/) or the PDF included with the program, found in the main menu under "Documents"
13+
* [Read the manual online](https://open-rails.readthedocs.io/en/latest/) or the PDF included with the program, found in the main menu under "Documents"
1414
* [Get additional materials, including tutorials, from our website](http://www.openrails.org/learn/manual-and-tutorials/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
1515
* [Read more about the project on our website](http://www.openrails.org/discover/open-rails/?utm_campaign=documentation&utm_source=readme&utm_medium=referral)
1616

Source/Documentation/Manual/physics.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,23 @@ simplicity, only one axle model is computed (and animated). A tilting
254254
feature and the independent axle adhesion model will be introduced in the
255255
future.
256256

257-
The heart of the model is the slip characteristics (picture below).
257+
The advanced adhesion model uses two alternate algorithms to calculate the
258+
wheel adhesion. The first model is based upon an algorithm by Pacha, whilst the second
259+
uses an algorithm developed by Polach. The Polach algorithm provides
260+
a more accurate outcome and facilitates the future inclusion of track conditions.
261+
However due to the number of algorithm steps required to calculate the wheel adhesion
262+
value, it is more CPU load intensive then the Pacha one. This can produce low
263+
frame rates for the screen display in machines with low performance specifications.
264+
265+
Hence OR automatically senses the CPU load, and switches to the Pacha algorithm at
266+
high loads and to the Polach algorithm under lower CPU loads. In this way OR attempts
267+
to support the operation of lower specification computers. When OR is using the
268+
Pacha algorithm, the "Wheel Adh (Max)" values will both read 99%, whereas when the
269+
Polach algorithm is being used these values will be around the expected values of 30-55%.
270+
271+
272+
273+
The heart of the adhesion algorithm is the slip characteristics (pictured below).
258274

259275
.. image:: images/physics-adhesion-slip.png
260276
:align: center

0 commit comments

Comments
 (0)