1457
1488
<ref name="diagnostic_scalar_field"/>
1460
<element name="source_absorption">
1461
<a:documentation>Select whether source and absorption terms for k and epsilon
1462
are implicit or explicit.</a:documentation>
1463
<element name="string_value">
1465
<value>explicit</value>
1466
<value>implicit</value>
1470
<element name="lengthscale_limit">
1471
<a:documentation>Limit the turbulence lengthscale to within physical bounds (e.g. inlet min dimension).
1472
This helps to prevent instabilities during simulation spin-up.</a:documentation>
1491
<element name="scalar_field">
1492
<a:documentation>f_1 damping coefficient for low_Re k-epsilon model
1493
Required for low_Re boundaries. If no low_Re boundaries are present
1494
this will be set to 1.0 throughout the domain and will not
1495
affect the result</a:documentation>
1496
<attribute name="rank">
1499
<attribute name="name">
1502
<element name="diagnostic">
1503
<ref name="internal_algorithm"/>
1504
<ref name="velocity_mesh_choice"/>
1505
<ref name="diagnostic_scalar_field"/>
1508
<element name="scalar_field">
1509
<a:documentation>f_2 damping coefficient for low_Re k-epsilon model
1510
Required for low_Re boundaries. If no low_Re boundaries are present
1511
this will be set to 1.0 throughout the domain and will not
1512
affect the result</a:documentation>
1513
<attribute name="rank">
1516
<attribute name="name">
1519
<element name="diagnostic">
1520
<ref name="internal_algorithm"/>
1521
<ref name="velocity_mesh_choice"/>
1522
<ref name="diagnostic_scalar_field"/>
1525
<element name="scalar_field">
1526
<a:documentation>f_mu damping coefficient for low_Re k-epsilon model
1527
Required for low_Re boundaries. If no low_Re boundaries are present
1528
this will be set to 1.0 throughout the domain and will not
1529
affect the result</a:documentation>
1530
<attribute name="rank">
1533
<attribute name="name">
1536
<element name="diagnostic">
1537
<ref name="internal_algorithm"/>
1538
<ref name="velocity_mesh_choice"/>
1539
<ref name="diagnostic_scalar_field"/>
1542
<element name="max_damping_value">
1543
<a:documentation>Limit the maximum value of damping function values. This helps stability when using low_Re number
1544
boundary conditions. If not using low_Re boundaries this will have no effect.
1545
Recommended value (default): 10.0</a:documentation>
1473
1546
<ref name="real"/>
1549
<element name="scalar_field">
1550
<a:documentation>Describes distance to nearest solid wall.
1551
Required for low_Re boundaries.
1552
For simple geometries the simplest method of providing this information is to use a python function.
1553
For complex geometries where this is not possible precursive Eikonal equation or Poisson equation
1554
simulations must be run using Fluidity to determine the values for this field.
1555
Details of how this is done can be found in:
1556
Tucker, P 2011: "Hybrid Hamilton/Jacobi/Poisson wall distance function model"
1557
Elias et al 2007: "Simple finite element-based computation of distance functions in unstructured grids"</a:documentation>
1558
<attribute name="rank">
1561
<attribute name="name">
1562
<value>DistanceToWall</value>
1564
<element name="prescribed">
1565
<ref name="velocity_mesh_choice"/>
1566
<ref name="prescribed_scalar_field"/>
1475
1570
<element name="C_mu">
1476
1571
<a:documentation>Eddy-viscosity coefficient: nu_T = density * C_mu * k**2 / epsilon.
1477
1572
Recommended value (default): 0.09.</a:documentation>
1498
1593
Recommended value (default): 1.3.</a:documentation>
1499
1594
<ref name="real"/>
1596
<element name="sigma_p">
1597
<a:documentation>The Schmidt number (ratio of viscous diffusion rate to momentum diffusion rate) for
1598
massive scalar fields, or Prandtl number (ratio of viscous diffusion rate to thermal diffusion rate)
1599
for thermal fields. This is used to calculate the turbulent buoyancy term.
1600
Recommended value (default): 1.0.</a:documentation>
1603
<element name="time_discretisation">
1604
<a:documentation>Time discretisation of the source terms in the k and epsilon equations and also
1605
of the eddy viscosity</a:documentation>
1606
<element name="theta">
1607
<a:documentation>Implicit/explicit control (THETA) of source terms and eddy viscosity in
1610
= 0.5 -- Crank-Nicolson
1611
= 1. -- implicit</a:documentation>
1614
<element name="source_term_implementation">
1615
<a:documentation>Each term in the k and epsilon equations can be implemented as either a
1616
source or as an absorbtion term. See the manual under
1617
'Parameterisations/Turbulent flow modelling and simulation/Reynolds Averaged Navier Stokes (RANS) Modelling/Standard k ā Īµ Turbulence Model/Time Discretisation and Coupling'
1618
for more information.</a:documentation>
1619
<element name="production_term">
1621
<value>source</value>
1622
<value>absorbtion</value>
1625
<element name="destruction_term">
1627
<value>source</value>
1628
<value>absorbtion</value>
1631
<element name="buoyancy_term">
1633
<value>source</value>
1634
<value>absorbtion</value>
1639
<element name="mass_terms">
1640
<a:documentation>The source terms in the k-epsilon model are calculated before the field is
1641
solved. The process requires inversion of a mass matrix. This element contains
1642
options for defining how this is done. For P1 meshes mass lumping can be used,
1643
for other discretisations the mass matrix can not be easily inverted and so a
1644
solve must be carried out, with solver options specified.</a:documentation>
1646
<element name="lump_mass">
1649
<element name="use_consistent_mass_matrix">
1650
<element name="solver">
1651
<ref name="linear_solver_options_asym"/>
1657
<element name="debugging_options">
1658
<a:documentation>produce vtu output of individual kk and eps source terms and set prescribed
1659
source terms for k and epsilon fields (for mms tests)</a:documentation>
1660
<element name="source_term_output_fields">
1661
<a:documentation>output fields for each of the source terms in the k-epsilon model</a:documentation>
1663
<element name="scalar_field">
1664
<attribute name="rank">
1667
<attribute name="name">
1668
<value>TurbulentKineticEnergy_production_term</value>
1670
<element name="diagnostic">
1671
<ref name="internal_algorithm"/>
1672
<ref name="velocity_mesh_choice"/>
1673
<ref name="diagnostic_scalar_field"/>
1678
<element name="scalar_field">
1679
<attribute name="rank">
1682
<attribute name="name">
1683
<value>TurbulentKineticEnergy_destruction_term</value>
1685
<element name="diagnostic">
1686
<ref name="internal_algorithm"/>
1687
<ref name="velocity_mesh_choice"/>
1688
<ref name="diagnostic_scalar_field"/>
1693
<element name="scalar_field">
1694
<attribute name="rank">
1697
<attribute name="name">
1698
<value>TurbulentKineticEnergy_buoyancy_term</value>
1700
<element name="diagnostic">
1701
<ref name="internal_algorithm"/>
1702
<ref name="velocity_mesh_choice"/>
1703
<ref name="diagnostic_scalar_field"/>
1708
<element name="scalar_field">
1709
<attribute name="rank">
1712
<attribute name="name">
1713
<value>TurbulentDissipation_production_term</value>
1715
<element name="diagnostic">
1716
<ref name="internal_algorithm"/>
1717
<ref name="velocity_mesh_choice"/>
1718
<ref name="diagnostic_scalar_field"/>
1723
<element name="scalar_field">
1724
<attribute name="rank">
1727
<attribute name="name">
1728
<value>TurbulentDissipation_destruction_term</value>
1730
<element name="diagnostic">
1731
<ref name="internal_algorithm"/>
1732
<ref name="velocity_mesh_choice"/>
1733
<ref name="diagnostic_scalar_field"/>
1738
<element name="scalar_field">
1739
<attribute name="rank">
1742
<attribute name="name">
1743
<value>TurbulentDissipation_buoyancy_term</value>
1745
<element name="diagnostic">
1746
<ref name="internal_algorithm"/>
1747
<ref name="velocity_mesh_choice"/>
1748
<ref name="diagnostic_scalar_field"/>
1753
<element name="prescribed_source_terms">
1754
<a:documentation>Enable to apply prescribed source terms into the k and epsilon equations.
1755
This is useful for MMS tests</a:documentation>
1757
<element name="scalar_field">
1758
<attribute name="rank">
1761
<attribute name="name">
1762
<value>TurbulentKineticEnergyPrescribedSource</value>
1764
<element name="prescribed">
1765
<ref name="velocity_mesh_choice"/>
1766
<ref name="prescribed_scalar_field"/>
1771
<element name="scalar_field">
1772
<attribute name="rank">
1775
<attribute name="name">
1776
<value>TurbulentDissipationPrescribedSource</value>
1778
<element name="prescribed">
1779
<ref name="velocity_mesh_choice"/>
1780
<ref name="prescribed_scalar_field"/>
1786
<element name="disable_production_term">
1787
<a:documentation>enabling this option disables the production term in the k and epsilon equations</a:documentation>
1792
<element name="disable_destruction_term">
1793
<a:documentation>enabling this option disables the destruction term in the k and epsilon equation</a:documentation>
1798
<element name="disable_buoyancy_term">
1799
<a:documentation>enabling this option disables the bouyancy term in the k and epsilon equation</a:documentation>
1804
<element name="enable_lowRe_damping">
1805
<a:documentation>enabling this option enables the low-Re number damping functions regardless of whether there is
1806
a low-Re boundary condition</a:documentation>
1811
<element name="zero_reynolds_stress_tensor">
1812
<a:documentation>Enabling this option disables feedback from the k-epsilon model back into
1813
the rest of the model. Reynolds stress tensor is set to zero by zeroing
1814
EddyViscosity and the added source term, based on k, in the momentum equation.
1815
Hence, Viscosity will always stay as the BackgroundViscosity,
1816
diffusivities will remain at the relevant BackgroundDiffusivity, and the
1817
momentum equation will be as if there were no turbulence model present.
1819
ScalarEddyViscosity is still calculated as normal.</a:documentation>
2186
2525
<ref name="flredecomp"/>
2528
<ref name="multiphase_interaction"/>
2190
2532
<define name="sediment">
2191
2533
<element name="sediment">
2192
<a:documentation>A simple sediment model in which different classes of sediment fall
2193
and diffuse at different rates.</a:documentation>
2194
<element name="scalar_field">
2195
<a:documentation>This field is the basis for all sediment fields. Each
2196
sediment class has a sediment field with name
2197
SedimentClassName where ClassName is the name of the
2200
By default, all sediment classes have exactly the same
2201
characteristics, however each class can be given its own
2202
settling velocity, diffusivity and initial condition under
2203
the sediment_class element and this will override the
2204
default specified here.</a:documentation>
2205
<attribute name="rank">
2208
<attribute name="name">
2209
<value>SedimentTemplate</value>
2211
<element name="prognostic">
2212
<a:documentation>Field type</a:documentation>
2213
<ref name="velocity_mesh_choice"/>
2214
<ref name="prognostic_scalar_field"/>
2217
<element name="density">
2218
<a:documentation>This is the density of this sediment. It will be used
2219
with the sediment concentration in the equation of state.
2220
Density must be specified here or for each sediment class.</a:documentation>
2225
<element name="diameter">
2226
<a:documentation>This is the diameter of the grain in mm.
2534
<a:documentation>A sediment model. See the manual for details on how to use this model.</a:documentation>
2536
<element name="scalar_field">
2537
<a:documentation>A single sediment field with discrete characteristics
2541
- a sinking velocity is required for sediment fields, this can be set for each
2542
sediment field under prognostic/SinkingVelocity
2544
- continuity must be the same for all fields. i.e. use the same mesh for all fields
2546
- rentrainment bc's can be used to allow sediment to be picked up from the bed
2547
due to turbulence. This must be set on the same boundaries as the SedimentDepositon
2550
- see the manual for more details on how to use this model </a:documentation>
2551
<attribute name="rank">
2554
<attribute name="name">
2555
<data type="string" datatypeLibrary=""/>
2557
<element name="prognostic">
2558
<a:documentation>Field type</a:documentation>
2559
<ref name="velocity_mesh_choice"/>
2560
<ref name="prognostic_scalar_field"/>
2561
<element name="scalar_field">
2562
<a:documentation>Sediment bedload diagnostic which records the sediment
2563
deposited through the prescribed boundary.
2565
The units are in unit distances as a depth of sediment.</a:documentation>
2566
<attribute name="rank">
2569
<attribute name="name">
2570
<value>Bedload</value>
2573
<a:documentation>Field type</a:documentation>
2574
<element name="diagnostic">
2575
<element name="surface_ids">
2576
<a:documentation>Surface ids over which to calculate the bedload:</a:documentation>
2577
<ref name="integer_vector"/>
2579
<ref name="diagnostic_scalar_field"/>
2581
<element name="prescribed">
2582
<element name="surface_ids">
2583
<a:documentation>Surface ids over which to calculate the bedload deposition:</a:documentation>
2584
<ref name="integer_vector"/>
2586
<ref name="prescribed_scalar_field"/>
2590
<element name="scalar_field">
2591
<a:documentation>Sediment bedload diagnostic which records the sediment
2592
deposited through the prescribed boundary.
2594
The units are in unit distances/second.</a:documentation>
2595
<attribute name="rank">
2598
<attribute name="name">
2599
<value>BedloadVolumeFraction</value>
2601
<element name="diagnostic">
2602
<a:documentation>Field type</a:documentation>
2603
<ref name="diagnostic_scalar_field"/>
2607
<element name="scalar_field">
2608
<a:documentation>Sediment bedload deposit rate diagnostic.
2610
The units are in unit distances/second.</a:documentation>
2611
<attribute name="rank">
2614
<attribute name="name">
2615
<value>BedloadDepositRate</value>
2617
<element name="diagnostic">
2618
<a:documentation>Field type</a:documentation>
2619
<ref name="diagnostic_scalar_field"/>
2624
<element name="scalar_field">
2625
<a:documentation>Sediment bedload erosion rate diagnostic.
2627
The units are in unit distances as a depth of sediment.</a:documentation>
2628
<attribute name="rank">
2631
<attribute name="name">
2632
<value>BedloadErosionRate</value>
2634
<element name="diagnostic">
2635
<a:documentation>Field type</a:documentation>
2636
<ref name="diagnostic_scalar_field"/>
2641
<element name="scalar_field">
2642
<a:documentation>This is the unhindered sinking velocity of the sediment particles.
2644
With the sinking velocity field set to diagnostic, this field is used, along with the sediment
2645
concentration, to calculate the hindered sinking velocity of sediment particles.
2647
This uses the equation developed by Richardson and Zaki [1954].
2649
If the 'SinkingVelocity' is not set to diagnostic, this field will not be used.
2651
As with the sinking velocity, this velocity is in the direction of gravity so if the substance
2652
floats upwards, this field should be negative.</a:documentation>
2653
<attribute name="name">
2654
<value>UnhinderedSinkingVelocity</value>
2656
<attribute name="rank">
2659
<element name="prescribed">
2660
<ref name="prescribed_scalar_field"/>
2664
<element name="submerged_specific_gravity">
2665
<a:documentation>This is the submerged specific gravity, R, of this sediment.
2666
It will be used with the sediment concentration in the equation
2667
of state, as well as in erosion algorithms.
2669
R = (rho_s - rho_a)/(rho_a)
2671
Where: rho_s is the sediment density and rho_a is the ambient fluid density</a:documentation>
2675
<element name="diameter">
2676
<a:documentation>This is the diameter of the grain.
2227
2677
Diameter must be specified here or under each sediment class.</a:documentation>
2232
<element name="porosity">
2233
<a:documentation>Set porosity to use. Default is 0.3. 1.0 is a sold material.</a:documentation>
2238
<element name="erodability">
2239
<a:documentation>Erodability of the sediment grain. A value of one means that only the
2682
<element name="bed_porosity">
2683
<a:documentation>Set porosity to use. Default is 0.3. 1.0 is a sold material.</a:documentation>
2688
<element name="erodability">
2689
<a:documentation>Erodability of the sediment grain. A value of one means that only the
2240
2690
critical shear stress is used to determine if a grain can be put into
2241
2691
suspension. A value of zero means these grains can never be resuspended.
2242
2692
Default is 1.</a:documentation>
2247
<element name="critical_shear_stress">
2248
<a:documentation>Critical shear stress of a grain. If not switched on a value
2697
<element name="critical_shear_stress">
2698
<a:documentation>Critical shear stress of a grain. If not switched on a value
2249
2699
will be computed according to the particle Reynolds number and Shield's
2250
criterion. Otherwise inoput a value in Nm-1</a:documentation>
2255
<element name="scalar_field">
2256
<a:documentation>This field is the template for the sediment flux
2257
diagnostic which records the flux of sediment through the
2258
domain boundary.</a:documentation>
2259
<attribute name="rank">
2262
<attribute name="name">
2263
<value>SedimentFluxTemplate</value>
2265
<element name="diagnostic">
2266
<a:documentation>Field type</a:documentation>
2267
<element name="surface_ids">
2268
<a:documentation>Surface ids over which to calculate the flux:</a:documentation>
2269
<ref name="integer_vector"/>
2271
<ref name="velocity_mesh_choice"/>
2272
<ref name="diagnostic_scalar_field"/>
2276
<element name="sediment_class">
2700
criterion.</a:documentation>
2707
<element name="scalar_field">
2708
<a:documentation>The median sediment diameter in the active layer of the bed.
2709
Required for some reentrainment algorithms.</a:documentation>
2710
<attribute name="rank">
2713
<attribute name="name">
2714
<value>SedimentBedActiveLayerD50</value>
2716
<element name="diagnostic">
2717
<element name="surface_ids">
2718
<a:documentation>Surface ids over which to calculate the bedload:</a:documentation>
2719
<ref name="integer_vector"/>
2721
<ref name="internal_algorithm"/>
2722
<ref name="velocity_mesh_choice"/>
2723
<ref name="diagnostic_scalar_field"/>
2726
<element name="scalar_field">
2727
<a:documentation>The standard deviation of sediment in the active layer of the
2728
bed. Required for some reentrainment algorithms</a:documentation>
2729
<attribute name="rank">
2732
<attribute name="name">
2733
<value>SedimentBedActiveLayerSigma</value>
2735
<element name="diagnostic">
2736
<element name="surface_ids">
2737
<a:documentation>Surface ids over which to calculate the bedload:</a:documentation>
2738
<ref name="integer_vector"/>
2740
<ref name="internal_algorithm"/>
2741
<ref name="velocity_mesh_choice"/>
2742
<ref name="diagnostic_scalar_field"/>
2746
<element name="tensor_field">
2747
<a:documentation>ZeroSedimentConcentrationViscosity field:
2749
Field for the viscosity of this a fluid with zero
2750
concentration of sediment.
2751
Required if using a diagnostic viscosity
2752
in a sediment problem where sediment concentration
2753
dependent viscosity is required.</a:documentation>
2754
<attribute name="rank">
2277
2757
<attribute name="name">
2278
<data type="string"/>
2758
<value>ZeroSedimentConcentrationViscosity</value>
2281
<ref name="initial_condition_scalar"/>
2284
<ref name="scalar_boundary_conditions"/>
2287
<element name="tensor_field">
2288
<a:documentation>Diffusivity for sediment class</a:documentation>
2289
<attribute name="name">
2290
<value>Diffusivity</value>
2292
<attribute name="rank">
2296
<element name="prescribed">
2298
<ref name="mesh_choice"/>
2300
<ref name="prescribed_tensor_field_no_adapt"/>
2302
<element name="diagnostic">
2303
<ref name="tensor_python_diagnostic_algorithm"/>
2304
<ref name="diagnostic_tensor_field"/>
2310
<element name="scalar_field">
2311
<a:documentation>Velocity at which this sediment sinks through the water column.
2313
This velocity is in the direction of gravity so if the substance
2314
floats upwards, this field should be negative.</a:documentation>
2315
<attribute name="name">
2316
<value>SinkingVelocity</value>
2318
<attribute name="rank">
2321
<element name="prescribed">
2322
<ref name="prescribed_scalar_field_no_adapt"/>
2327
<element name="density">
2328
<a:documentation>This is the density of this sediment. It will be used
2329
with the sediment concentration in the equation of state.</a:documentation>
2334
<element name="diameter">
2335
<a:documentation>This is the diamter of the grain in mm</a:documentation>
2340
<element name="erodability">
2341
<a:documentation>Erodability of the sediment grain. A value of one means that only the
2342
critical shear stress is used to determine if a grain can be put into
2343
suspension. A value of zero means these grains can never be resuspended.
2344
Default is 1.</a:documentation>
2349
<element name="critical_shear_stress">
2350
<a:documentation>Critical shear stress of a grain. If not switched on a value
2351
will be computed according to the particle Reynolds number and Shield's
2352
criterion. Otherwise inoput a value in Nm-1</a:documentation>
2761
<element name="prescribed">
2762
<ref name="velocity_mesh_choice"/>
2763
<ref name="prescribed_tensor_field"/>
2765
<element name="aliased">
2766
<ref name="generic_aliased_field"/>
2360
2773
<define name="prognostic_density_field">
added
removed
schemas/fluidity_options.rng
