Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

some schema description fixes #610

Merged
merged 1 commit into from
Feb 15, 2024
Merged

some schema description fixes #610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions doc/world_builder_declarations.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"oneOf": [
{
"type": "object",
"description": "A Cartesian coordinate system. Coordinates are (x,y,z) and extend infintly in all directions.",
"description": "A Cartesian coordinate system. Coordinates are (x,y,z) and extend infinitely in all directions.",
"additionalProperties": false,
"required": [
"model"
Expand All @@ -89,7 +89,7 @@
"model": {
"default value": "",
"type": "string",
"description": "The name which the user has given to the feature.",
"description": "The name of the coordinate system to use.",
"enum": [
"cartesian"
]
Expand All @@ -108,7 +108,7 @@
"model": {
"default value": "",
"type": "string",
"description": "The name which the user has given to the feature.",
"description": "The name of the coordinate system to use.",
"enum": [
"spherical"
]
Expand Down Expand Up @@ -149,7 +149,7 @@
"model": {
"default value": "",
"type": "string",
"description": "The name which the user has given to the feature.",
"description": "The name of the model for the gravity to use.",
"enum": [
"uniform"
]
Expand Down Expand Up @@ -180,7 +180,7 @@
"model": {
"default value": "",
"type": "string",
"description": "The name which the user has given to the feature.",
"description": "The model name of the feature determining its type.",
"enum": [
"continental plate"
]
Expand Down Expand Up @@ -1211,7 +1211,7 @@
"model": {
"default value": "",
"type": "string",
"description": "The name which the user has given to the feature.",
"description": "The model name of the feature determining its type.",
"enum": [
"fault"
]
Expand Down Expand Up @@ -3372,7 +3372,7 @@
"model": {
"default value": "",
"type": "string",
"description": "The name which the user has given to the feature.",
"description": "The model name of the feature determining its type.",
"enum": [
"mantle layer"
]
Expand Down Expand Up @@ -4402,7 +4402,7 @@
"model": {
"default value": "",
"type": "string",
"description": "The name which the user has given to the feature.",
"description": "The model name of the feature determining its type.",
"enum": [
"oceanic plate"
]
Expand Down Expand Up @@ -5882,7 +5882,7 @@
"model": {
"default value": "",
"type": "string",
"description": "The name which the user has given to the feature.",
"description": "The model name of the feature determining its type.",
"enum": [
"subducting plate"
]
Expand Down
18 changes: 9 additions & 9 deletions doc/world_builder_declarations_closed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
:name: closed_coordinate-system_oneOf_1

- **type**:object
- **description**:A Cartesian coordinate system. Coordinates are (x,y,z) and extend infintly in all directions.
- **description**:A Cartesian coordinate system. Coordinates are (x,y,z) and extend infinitely in all directions.
- **additionalProperties**:false
- **required**:[model]

Expand All @@ -134,7 +134,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The name of the coordinate system to use.
- **enum**:[cartesian]
:::::::::::::::::::::

Expand All @@ -155,7 +155,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The name of the coordinate system to use.
- **enum**:[spherical]
:::::::::::::::::::::

Expand Down Expand Up @@ -205,7 +205,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The name of the model for the gravity to use.
- **enum**:[uniform]
:::::::::::::::::::::

Expand Down Expand Up @@ -249,7 +249,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The model name of the feature determining its type.
- **enum**:[continental plate]
::::::::::::::::::::

Expand Down Expand Up @@ -1846,7 +1846,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The model name of the feature determining its type.
- **enum**:[fault]
::::::::::::::::::::

Expand Down Expand Up @@ -4807,7 +4807,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The model name of the feature determining its type.
- **enum**:[mantle layer]
::::::::::::::::::::

Expand Down Expand Up @@ -6404,7 +6404,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The model name of the feature determining its type.
- **enum**:[oceanic plate]
::::::::::::::::::::

Expand Down Expand Up @@ -8689,7 +8689,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The model name of the feature determining its type.
- **enum**:[subducting plate]
::::::::::::::::::::

Expand Down
18 changes: 9 additions & 9 deletions doc/world_builder_declarations_open.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@
:name: open_coordinate-system_oneOf_1

- **type**:object
- **description**:A Cartesian coordinate system. Coordinates are (x,y,z) and extend infintly in all directions.
- **description**:A Cartesian coordinate system. Coordinates are (x,y,z) and extend infinitely in all directions.
- **additionalProperties**:false
- **required**:[model]

Expand All @@ -151,7 +151,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The name of the coordinate system to use.
- **enum**:[cartesian]
:::::::::::::::::::::

Expand All @@ -174,7 +174,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The name of the coordinate system to use.
- **enum**:[spherical]
:::::::::::::::::::::

Expand Down Expand Up @@ -230,7 +230,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The name of the model for the gravity to use.
- **enum**:[uniform]
:::::::::::::::::::::

Expand Down Expand Up @@ -280,7 +280,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The model name of the feature determining its type.
- **enum**:[continental plate]
::::::::::::::::::::

Expand Down Expand Up @@ -2092,7 +2092,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The model name of the feature determining its type.
- **enum**:[fault]
::::::::::::::::::::

Expand Down Expand Up @@ -5397,7 +5397,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The model name of the feature determining its type.
- **enum**:[mantle layer]
::::::::::::::::::::

Expand Down Expand Up @@ -7209,7 +7209,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The model name of the feature determining its type.
- **enum**:[oceanic plate]
::::::::::::::::::::

Expand Down Expand Up @@ -9801,7 +9801,7 @@

- **default value**:
- **type**:string
- **description**:The name which the user has given to the feature.
- **description**:The model name of the feature determining its type.
- **enum**:[subducting plate]
::::::::::::::::::::

Expand Down
6 changes: 3 additions & 3 deletions source/world_builder/coordinate_systems/cartesian.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ namespace WorldBuilder
Cartesian::declare_entries(Parameters &prm, const std::string & /*unused*/)
{
prm.declare_entry("", Types::Object(),
"A Cartesian coordinate system. Coordinates are (x,y,z) and extend infintly in all directions.");
"A Cartesian coordinate system. Coordinates are (x,y,z) and extend infinitely in all directions.");
}

void
Expand Down Expand Up @@ -77,9 +77,9 @@ namespace WorldBuilder
Cartesian::distance_between_points_at_same_depth(const Point<3> &point_1, const Point<3> &point_2) const
{
WBAssert(point_1.get_coordinate_system() == cartesian,
"Can not convert non cartesian points through the cartesian coordinate system.");
"Can not convert non-Cartesian points through the Cartesian coordinate system.");
WBAssert(point_2.get_coordinate_system() == cartesian,
"Can not convert non cartesian points through the cartesian coordinate system.");
"Can not convert non-Cartesian points through the Cartesian coordinate system.");
// Todo: check that points are at the same depth.
const Point<3> difference = point_1-point_2;
const Point<2> point_at_depth(difference[0],difference[1], cartesian);
Expand Down
2 changes: 1 addition & 1 deletion source/world_builder/coordinate_systems/interface.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ namespace WorldBuilder
prm.declare_entry("", Types::Object(required_entries), "Coordinate system object");

prm.declare_entry("model",Types::String("",iter.first),
"The name which the user has given to the feature.");
"The name of the coordinate system to use.");

iter.second(prm, parent_name);
}
Expand Down
2 changes: 1 addition & 1 deletion source/world_builder/features/interface.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ namespace WorldBuilder
prm.declare_entry("", Types::Object(required_entries), "feature object");

prm.declare_entry("model", Types::String("",it.first),
"The name which the user has given to the feature.");
"The model name of the feature determining its type.");
prm.declare_entry("name", Types::String(""),
"The name which the user has given to the feature.");
prm.declare_entry("coordinates", Types::Array(Types::Point<2>(), 1),
Expand Down
2 changes: 1 addition & 1 deletion source/world_builder/gravity_model/interface.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ namespace WorldBuilder
prm.declare_entry("", Types::Object(required_entries), "gravity model");

prm.declare_entry("model",Types::String("",it.first),
"The name which the user has given to the feature.");
"The name of the model for the gravity to use.");

it.second(prm, parent_name);
}
Expand Down
Loading