Description="Channel geometric parameters of the channel geometry object. It should be two values with the first one being nominal channel flow area and the second one being the nominal channel wetted perimeter."
MinOccurs=1
Description="A shortcut to writing 'area' and 'pw' separately. Accepts two values, which should be flow area and wetted perimeter."
MinOccurs=0
MaxOccurs=1
value{
ValType="Real"
@@ -310,6 +312,28 @@ ch_geo{
MaxOccurs=2
}
}
area{
Description="Area of the channel geometric object."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../pw"
value{
ValType="Real"
MinOccurs=1
MaxOccurs=1
}
}
pw{
Description="Wetted perimeter of the channel geometric object."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../area"
value{
ValType="Real"
MinOccurs=1
MaxOccurs=1
}
}
}
# IDs have to go from 1 to N without skips. This ensures 1 and N are there.
@@ -321,7 +345,7 @@ ch{
MinOccurs=1
MaxOccurs=NoLimit
id{
Description="Stopping criteria for the l:math:`\infty`-norm of relative pressure changes between solution checkpoints."
Description="ID of the channel"
MinOccurs=1
MaxOccurs=1
value{
@@ -560,10 +584,61 @@ section{
}
}
ChildUniqueness="gap_geo/id/value"
gap_geo{
Description="Use to specify a reference gap geometry which can be referenced when defining gaps."
MinOccurs=0
MaxOccurs=NoLimit
id{
Description="ID of the gap geometry object."
MinOccurs=1
MaxOccurs=1
value{
ValType="String"
MinOccurs=1
MaxOccurs=1
}
}
ChildExactlyOne=[length, geo]
ChildExactlyOne=[width, geo]
geo{
Description="Gap geometric parameters of the gap geometry object. It should be two values with the first one being length of the gap and the second one being the width of the gap."
MinOccurs=0
MaxOccurs=1
value{
ValType="Real"
MinOccurs=2
MaxOccurs=2
}
}
length{
Description="Length of the gap geometric object."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../width"
value{
ValType="Real"
MinOccurs=1
MaxOccurs=1
}
}
width{
Description="Width of the gap geometric object."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../length"
value{
ValType="Real"
MinOccurs=1
MaxOccurs=1
}
}
}
ChildUniqueness="gap/id/value"
ChildAtMostOne=["gap/id/value"=1]
gap{
Description="Declares a gap in the model."
Description="Declares a gap in the model. There are three different ways in which the gap geometry can be defined. The first, is by specifying each individual geometric parameter alongside their respective keyword (length and width), the second, is by pointing to a reference gap geometric object defined in geo_ref, and the third, is by listing all the gap geometry parameters at once using the 'geo' keyword."
MinOccurs=0
MaxOccurs=NoLimit
id{
@@ -574,8 +649,11 @@ gap{
MinOccurs=1
MaxOccurs=1
ValType=Int
MinValInc=1
}
}
ChildExactlyOne=[length, geo, geo_ref]
ChildExactlyOne=[width, geo, geo_ref]
chconn{
Description="A pair of the connected channel IDs for the gap."
### Appearance="The channel IDs must be defined in the ch block."
@@ -588,9 +666,11 @@ gap{
}
}
length{
MinOccurs=0
Description="The length of the gap defined as the distance between the channel centroids."
MinOccurs=1
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../width"
value{
MinOccurs=1
MaxOccurs=1
@@ -598,15 +678,39 @@ gap{
}
}
width{
MinOccurs=0
Description="The width of the gap defined as the distance across the other direction."
MinOccurs=1
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../length"
value{
MinOccurs=1
MaxOccurs=1
ValType=Real
}
}
geo{
Description="A shortcut to writing 'length' and 'width' separately. Accepts two values, which should be length and width of the gap"
MinOccurs=0
MaxOccurs=1
value{
ValType="Real"
MinOccurs=2
MaxOccurs=2
}
}
geo_ref{
Description="ID of the gap geometry object defined in the gap_geo block."
### Appearance="ID must be defined in the gap_geo block"
:Description: Defines a channel in the model. There are three different ways in which the channel geometry can be defined. The first, is by specifying each individual geometric parameter alongside their respective keyword (e.g., area, pw), the second, is by pointing to a reference channel geometric object defined in geo_ref, and the third, is by listing all the channel geometry parameters at once using the 'geo' keyword. The Channel mesh parameters can be specified individually or listed all at once under the 'mesh' keyword.
@@ -493,13 +513,13 @@ geo
geo_ref
-------
:Description: ID of the channel geometry object defined in the ch_geo block.
:Description: ID of the gap geometry object defined in the gap_geo block.
:Min Occurance: 1
:Max Occurance: 1
:Units: n/a
:Type: "String"
:Range: n/a
:Note: ID must be defined in the ch_geo block
:Note: ID must be defined in the gap_geo block
x
-
@@ -671,9 +691,59 @@ dz
:Range: n/a
:Note: n/a
gap_geo
=======
:Description: Use to specify a reference gap geometry which can be referenced when defining gaps.
:Min Occurance: 0
:Max Occurance: NoLimit
:Units: n/a
:Type: n/a
:Range: n/a
:Note: n/a
id
--
:Description: Specify the parallel domain ID.
:Min Occurance: 1
:Max Occurance: 1
:Units: n/a
:Type: Int
:Range: >=1
:Note: ID can be string or integer type
geo
---
:Description: ID of the solid reference geometry defined in the solid_geo block.
:Min Occurance: 1
:Max Occurance: 1
:Units: n/a
:Type: Int
:Range: >=1
:Note: ID must exist in the 'solid_geo' block
length
------
:Description: The length of the gap defined as the distance between the channel centroids.
:Min Occurance: 1
:Max Occurance: 1
:Units: n/a
:Type: Real
:Range: n/a
:Note: n/a
width
-----
:Description: The width of the gap defined as the distance across the other direction.
:Min Occurance: 1
:Max Occurance: 1
:Units: n/a
:Type: Real
:Range: n/a
:Note: n/a
gap
===
:Description: Declares a gap in the model.
:Description: Declares a gap in the model. There are three different ways in which the gap geometry can be defined. The first, is by specifying each individual geometric parameter alongside their respective keyword (length and width), the second, is by pointing to a reference gap geometric object defined in geo_ref, and the third, is by listing all the gap geometry parameters at once using the 'geo' keyword.
:Min Occurance: 0
:Max Occurance: NoLimit
:Units: n/a
@@ -721,6 +791,26 @@ width
:Range: n/a
:Note: n/a
geo
---
:Description: ID of the solid reference geometry defined in the solid_geo block.
:Min Occurance: 1
:Max Occurance: 1
:Units: n/a
:Type: Int
:Range: >=1
:Note: ID must exist in the 'solid_geo' block
geo_ref
-------
:Description: ID of the gap geometry object defined in the gap_geo block.
:Min Occurance: 1
:Max Occurance: 1
:Units: n/a
:Type: "String"
:Range: n/a
:Note: ID must be defined in the gap_geo block
solid_geo
=========
:Description: Specify a reference solid geometry which can be referenced when defining solids.
