SolverDefinition¶
SolverDefinition element contains definition information of the solver.
Examples¶
1<SolverDefinition
2 name="samplesolver"
3 caption="Sample Solver 1.0"
4 version="1.0"
5 copyright="Example Company"
6 release="2012.04.01"
7 homepage="http://example.com/"
8 executable="solver.exe"
9 iterationtype="time"
10 gridtype="structured2d"
11>
12 <CalculationCondition>
13
14 (abbr.)
15
16 </CalculationCondition>
17 <GridRelatedCondition>
18
19 (abbr.)
20
21 </GridRelatedCondition>
22</SolverDefinition>
Attributes¶
Name |
Value |
Required |
Description |
|
---|---|---|---|---|
name |
String |
Yes |
Identification name of the solver (in alphanumeric characters only) |
|
caption |
String |
Yes |
Name of the solver (any characters can be used) |
|
version |
String |
Yes |
Version number, in a form such as \”1.0\”, \”1.3.2\” |
|
copyright |
String |
Yes |
Name of copyright owner; basically in English |
|
release |
String |
Yes |
Date of release, in a form such as \”2010.01.01\” |
|
homepage |
String |
Yes |
URL of the web page that provides information on the solver |
|
executable |
String |
Yes |
Filename of the executable program. (e.g. |
Solver.exe) |
iterationtype |
Refer to table below |
Yes |
Unit of outputting result |
|
gridtype |
Refer to table below |
Yes |
Grid type |
|
multiple |
true or false |
true if two or more grids can be used |
Value |
Meaning |
---|---|
time |
Results are output by time |
iteration |
Results are output by iteration |
Value |
Meaning |
---|---|
1d |
one-dimensional grid |
1.5d |
one-and-half dimensional grid |
1.5d_withcrosssection |
one-and-half dimensional grid having cross-sectional info |
structured2d |
two-dimensional structured grid |
unstructured2d |
two-dimensional unstructured grid |
When solver developers want to update solvers, version attribute should be changed. Refer to Notes on solver version up for notes on solver version up.
Child elements¶
Name |
Required |
Description |
---|---|---|
CalculationCondition |
Yes |
Calculation condition |
GridRelatedCondition |
This should be defined only when a single type of input grid is used. |
|
GridTypes |
This should be defined only when two or more types of input grids are used. |