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.

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

Model solver name and operation as data properties #38

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
116 changes: 86 additions & 30 deletions adapter-config-schema/preatcs.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,43 +66,99 @@
"nodes"
]
},
"write_data_names": {
"write_data": {
"type": "array",
"description": "List of data fields to be written on this mesh.",
"description": "List of data fields to be written to this mesh.",
"items": {
"type": "string",
"examples": [
"Force",
"Displacement",
"Velocity",
"Temperature",
"Heat-Flux",
"Force1",
"Force-Left",
"Heat-Transfer-Coefficient",
"Sink-Temperature"
],
"minLength": 1,
"pattern": "^[A-Z][a-zA-Z0-9]*(?:-[A-Za-z0-9]+)*$"
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the data as specified in the preCICE configuration.",
"examples": [
"Force",
"Displacement",
"Velocity",
"Temperature",
"Heat-Flux",
"Force1",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this something we want to give as an example and, hence, encourage it?
What was the inspiration for this example in the first place (I know it was introduced earlier)?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tapegoji @BenjaminRodenberg @mathiskelm @IshaanDesai @vidulejs @MakisH @dabele: Does this cover your requirements?

Yes, this will do for my side.

I envision transferring Joule-Heat from Elmer to preCICE in some of the applications for Volume to Volume coupling. If we can give example for volume-to-volume coupling, it might be useful.

"Force-Left",
"Heat-Transfer-Coefficient",
"Sink-Temperature"
],
"minLength": 1,
"pattern": "^[A-Z][a-zA-Z0-9]*(?:-[A-Za-z0-9]+)*$"
},
"solver_name": {
"type": "string",
"description": "Name of the data as used by the solver (optional).",
"examples": [
"temp",
"T"
],
"minLength": 1
},
"operation": {
"type": "string",
"description": "Operation applied by the adapter on the data (optional).",
"examples": [
"value",
"gradient"
],
"minLength": 1
}
},
"required": [
"name"
]
},
"minItems": 1
},
"read_data_names": {
"read_data": {
"type": "array",
"description": "List of data fields to be read on this mesh.",
"description": "List of data fields to be read from this mesh.",
"items": {
"type": "string",
"examples": [
"Force",
"Displacement",
"Velocity",
"Temperature",
"Heat-Flux",
"Force1",
"Force-Left"
],
"minLength": 1,
"pattern": "^[A-Z][a-zA-Z0-9]*(?:-[A-Za-z0-9]+)*$"
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the data as specified in the preCICE configuration.",
"examples": [
"Force",
"Displacement",
"Velocity",
"Temperature",
"Heat-Flux",
"Force1",
"Force-Left",
"Heat-Transfer-Coefficient",
"Sink-Temperature"
],
"minLength": 1,
"pattern": "^[A-Z][a-zA-Z0-9]*(?:-[A-Za-z0-9]+)*$"
},
"solver_name": {
"type": "string",
"description": "Name of the data as used by the solver (optional)",
"examples": [
"temp",
"T"
],
"minLength": 1
},
"operation": {
"type": "string",
"description": "Operation applied by the adapter on the data (optional)",
"examples": [
"value",
"gradient"
],
"minLength": 1
}
},
"required": [
"name"
]
},
"minItems": 1
},
Expand Down