17.6.1. Format and Details of an icUserSettings.txt File

The following list shows the format and details of each of the fields.

solution-type

Set to "cold-flow" or "port-flow", or "combustion"depending upon the solution type you have chosen.

combustion-simulation-type

Set to "sector", or "full_engine_ivc_to_evo", or "full_engine_full_cycle" depending upon the combustion simulation type you have chosen.

initialize-flow?

Set to #t (true) or #f (false) depending upon whether you want to initialize the flow or not.

report-mesh?

Set to #t (true) or #f (false) depending upon whether you want to generate a mesh report after running the calculation.

report-urf?

Set to #t (true) or #f (false) depending upon whether you want the under relaxation factors included in the report or not.

set-default-models?

Set to #t (true) or #f (false) depending upon whether you are using the default models set for this type of solution.

data-sampling

Set to #t (true) or #f (false) depending upon whether sampling of date is enabled during the unsteady calculation.

auto-save-type

Set to "CA" (Crank Angle) or "time" (time steps) depending upon whether you want to save the case and data files at a specific frequency of crank angle or time steps.

auto-save-freq

The number of crank angle or time steps after which the case and data file is saved in Fluent. If it is set to #f, then only the final case and data files are saved.

num-of-CA

Set to the number of crank angles you want the solution to run.

ice-swirl-number

Set to the default swirl number of 1.3 or to the value you chose.

ice-chemkin-file

Set to #f if no file is provided. If file is provided then it shows the path where the file is saved.

ice-them-data-file

Set to #f if no file is provided. If file is provided then it shows the path where the file is saved.

profile-file

Set to #f if no file is provided. If file is provided then it shows the path where the file is saved.

set-default-urf?

Set to#t (true) or #f (false) depending upon whether you are using the default under-relaxation factors or setting your own.

set-bc?

Set to#t (true) or #f (false). When this is #t it will set the boundary conditions specified in the inlet_outlet_bc_list and wall_bc_list.

ice-initialization values

Shows the parameters and their initialization values.

ice-combustion-model-param

Shows the selected combustion model and the mixture material

inlet_outlet_bc_list

Lists the information about the inlets and outlets in the format:

(list-no (zone "Zone-Name") (type "Type")(data-profile "no" "profile-name" "field-name" /value) (temperature-profile "yes/no" value) (turbulence "Turbulence Specification Method" value1 value2)))

Here list-no is used to list the serial number of inlets and outlets.

"Zone-name" is the name of the zone to which you are applying the boundary conditions.

"Type" will be "pressure-inlet", "pressure-oulet", or "mass-flow-inlet".

You can enter yes or no for the data-profile or temperature-profile. If you want to provide a profile enter yes. The format changes to (data-profile "yes" "profile-name" "field-name"). Here "profile-name" is the name of the profile in the file provided, and "field-name" is the field within the profile that contains the data.

If you specify no, then a value should be provided for the parameter.

The "Turbulence Specification Method" can be either Intensity and Viscosity Ratio ("int-vis-ratio") or Intensity and Hydraulic Diameter ("int-hyd-dia").

The value1 is value of Turbulent Intensity. value2 can be Turbulent Viscosity Ratio or Hydraulic Diameter depending on the Specification Method selected. An example is shown below.

inlet_outlet_bc_list	(
(1(zone "ice-inlet")(type "pressure-inlet")(data-profile "no" 500)(temperature-profile "no" 400)
(turbulence "int-hyd-dia" 2 5))
(2(zone "ice-outlet")(type "pressure-outlet")(data-profile "no" 0)(temperature-profile "no" 700)
(turbulence "int-hyd-dia" 2 5))
(3(zone "ice-inlet-invalve-1-port")(type "pressure-inlet")(data-profile "yes" "in-mflow-prof")
(temperature-profile "yes" "in-temp-prof" "temp")(turbulence "int-hyd-dia" 2 0.027))	)
wall_bc_list

Lists the information about the walls in the format shown:

((list-no (zone "Zone-Name") (data-profile "no" value)(slipwall "yes")))

Here list-no is used to list the serial number of walls.

"Zone-name" is the name of the zone to which you are applying the boundary conditions. If you want to set one value on all the zones, set "Zone-name" to "all". You can add individual zones thereafter that will overwrite the conditions set for "all" zones.

You can enter yes or no for the data-profile. If you want to provide a profile enter yes. The format changes to (data-profile "yes" "profile-name" "field-name"). Here "profile-name" is the name of the profile in the file provided, and "field-name" is the field within the profile that contains the data.

If you specify no, then a value should be provided for the parameter.

You can enter yes or no for the slipwall. If you choose "yes" then Specified Shear is selected from Shear Condition group box and you can provide the Shear Stress in the wall boundary condition dialog box in Fluent. For "no", No Slip is selected from Shear Condition group box. slipwall term is present only for Port Flow Simulation.

patching_values

Temperature and pressure of multiple zones can be patched to specific values using the following string. This term is present only for Cold Flow Simulation.

(("pressure" value (zone1 zone2...)))(("temperature" value (zone1 zone2...)))

post_planes

Lists the location and the name of the plane created for postprocessing the results, default planes created and any planes you added after decomposition. You can also add your planes here in the file using the format given. Ensure that the plane name starts with "ice_user_plane_".

This takes input in the form of (("plane" (x y z) (x y z) (x y z)))

You can add a plane using IC_setting_manager. After decomposition this feature is created in the Tree Outline. Right-click IC_setting_manager and select Insert and then New Plane from the context menu. Ensure that the plane name starts with "ice_user_plane_". Click Generate to complete the procedure.

If you would like to add a swirl plane for port flow simulation, follow the procedure of creating a plane using the IC_setting_manager feature. Ensure that the name starts with "ice_swirl_plane_".

Insert → New Plane

After you add the new planes using IC_setting_manager they are automatically added to the icBcSettings.txt file under the tag of post_planes.

post_plane_images

This term has different formats depending on how you want the images captured.

post_plane_images (
  • When you want only animation from the images and do not require a table, use the following format:

    ( (name "imagename1") (surfaces ("plane1" "inlet1" "outlet1")) (view "ice-plane1-view1") 
    (quantities ("velocity-magnitude" "pressure")) (interval-tag ((start-CA 15) (end-CA 45) (frequency 2)) ) 
    (anim-properties (animation? #t)) (table-properties (table? #f) (columns #f) (rows #f) (tag "")) )
  • When you require an animation and also a table for some of the images, use the following format:

    ( (name "imagename2") (surfaces ("plane1" "inlet1" "outlet1")) (view "ice-plane1-view1") 
    (quantities ("velocity-magnitude" "pressure")) (interval-tag ((start-CA 15) (end-CA 45) (frequency 2)) ) 
    (anim-properties (animation? #t)) (table-properties (table? #t)  (columns #3) (rows #5) (tag "")) )
  • When you do not require an animation but a table for images taken in intervals so that all images appear in the table, use the following format:

    ( (name "imagename3") (surfaces ("plane1" "inlet1" "outlet1")) (view "ice-plane1-view1") 
    (quantities ("velocity-magnitude" "pressure")) (interval-tag ((start-CA 15) (end-CA 45) (frequency 2)) ) 
    (anim-properties (animation? #f)) (table-properties (table? #t) (columns #3) (rows #5) (tag "my-table-new")) )
  • When the frequency is 0, only the last image of the simulation is captured. To arrange the multiple images in a table use the following format:

    ( (name "imagename4") (surfaces ("plane1")) (view "ice-plane1-view1") (quantities ("velocity-magnitude")) 
    (interval-tag ((start-CA #f) (end-CA #f) (frequency #f)) ) (anim-prperties (animation? #f) ) 
    (table-properties (table? #t) (columns #3) (rows #5) (tag "my-table")) )
    
    ( (name "imagename5") (surfaces ("plane2")) (view "ice-plane1-view1") (quantities ("velocity-magnitude")) 
    (interval-tag ((start-CA #f) (end-CA #f) (frequency #f)) ) (anim-prperties (animation? #f) ) 
    (table-properties (table? #t) (columns #3) (rows #5) (tag "my-table")) )
  • When you need just the images without any animation or the table, use the following format:

    ( (name "imagename6") (surfaces ("plane2")) (view "ice-plane1-view1") 
    (quantities ("velocity-magnitude" )) (interval-tag ((start-CA 0) (end-CA 360) (frequency 20)) ) 
    (anim-prperties (animation? #f) ) (table-properties (table? #f) (columns #3) (rows #5) (tag "")) ) 

    Note:  In this case the images are stored in the Report folder. The images will not appear in the Report.html.


In the above formats there are different tags, like name, surfaces, view, interval-tag, and so on. Each tag is explained in detail below.

name

The name given to each sublist of the post_plane_image list. Each list should be named differently.

surfaces

These are the surfaces on which the images are displayed. You can choose multiple valid surfaces as ("plane1" "inlet1" "outlet1") or any plane you have created. Every image will contain all the surfaces you have entered. If you require a different image for another surface then you should create a different sublist with a different name.

view

View is required to capture an image. So you have to specify at which view you want the image captured. Some views are created by default, based on the number of post_planes in the format of "plane_name-view". Apart from these views one ice_iso_view is also created.

quantities

You can specify any parameter for the contour you require, for example, velocity, temperature, pressure, and so on. For every quantity one image will be captured on the number of surfaces you have provided.

interval-tag

You can use this feature when you require images in between some crank angles. It gives you the flexibility to specify the intervals and the frequency at which you require the images.

The tags start-CA and end-CA are for transient solutions where crank angle is taken as input. So in between the specified start-CA and end-CA images will be captured at the specified frequency of crank angle. For example, if frequency is set to 2 then images are captured at every 2 crank angles, from start-CA to end-CA.

For steady cases the tags are changed to start-iter and end-iter, where iteration is taken as input. For a steady case you can give input as frequency only, and the rest two tags can be set to #f. In this case the images will be captured at that frequency of iterations, starting from the beginning of the solution. For example, if frequency is set to 2 then images are captured at every 2 iterations.

anim-properties

If you require animation of some images you must provide the animation? tag as #t. Then the animation of the images will be created in the report.

table-properties

Creates a table of the images captured. The table is created only when table? tag is set to #t. You then have to mention the table size by providing values for columns and rows tag.

tag is useful if you want only the final images of different surfaces in a single table. In this case you have to provide the same tag to each sublist. The row and column numbers of the first sublist of the same tag will be considered.

swirl_def

This term helps in monitoring swirl ratio on the swirl planes. This term is present only for Port Flow Simulation. The swirl definition is as follows:

= x

(17–1)

SN = [] * mass flow rate

(17–2)

where 
  = angular momentum per unit mass
 SN = swirl number
 r = radial coordinate, (that is, facet center-swirl center)
  = velocity
  = swirl axis

The swirl_def term is defined in the following way in the icBcSettings.txt file.

(
((name "swirl1")
(swirl-center ( X Y Z ))
(swirl-axis ( X1 Y1 Z1 ))
(function "(X1*am_x_swirl1) + (Y1*am_y_swirl1) + (Z1*am_z_swirl1)") )
)

Here a custom field function is created in Fluent with the name given for the name tag. swirl-center signifies the location of swirl center, and swirl-axis signifies the direction of swirl axis. function tag is used to create the custom field function using the corresponding formula.

Custom field functions with the names am_x_name, am_y_name, and am_z_name are created automatically based on swirl-center. These terms are the components of the vector am. You can use these terms and create any formula using the function tag.

If you would like to add a swirl plane for port flow simulation, use the feature IC_setting_manager. After decomposition this feature is created in the Tree Outline. Right-click IC_setting_manager and select Insert and then New Plane from the context menu. Ensure that the plane name starts with "ice_swirl_plane_". Click Generate to complete the procedure.

IC_setting_manager Insert New Plane

After you add the new planes using IC_setting_manager they are automatically added to the icBcSettings.txt file under the tag of post_planes and the custom field function is also automatically added under the swirl_def tag.

monitor_def

Defines the default monitors.

("Name of the monitor" "Monitor Type" "Report Type" "Field Variable" (Cell Zones))

The Monitor Type can be volume for Volume Monitor or surface for Surface Monitor.

For volume monitor the Report Type can be Volume-Average, Volume, Sum, Max, Min, Volume-Integral, Mass Integral, or Mass Average.

For surface monitor the Report Type can be Integral, Standard Deviation, Flow Rate, Mass Flow Rate, Volume Flow Rate, Area-Weighted Average, Mass-Weighted Average, Sum, Uniformity Index - Mass Weighted, Uniformity Index - Area Weighted, Facet Average, Facet Minimum, Facet Maximum, Vertex Average, Vertex Minimum, or Vertex Maximum.

You can choose the field you want to monitor by entering it for Field Variable.

You can also choose the zone you want to monitor by entering it for (Cell Zones).

In the example here, the first monitor name is vol-avg-pressure-mon. The Monitor Type is volume (Volume Monitor). The Report Type chosen is Volume-Average and the Field Variable is pressure. The Cell Zones on which the variable is monitored are fluid-ch fluid-piston-layer.

swirl_data

term helps in plotting swirl ratio as a function of CA. This term is present only for Cold Flow Simulation.

(( 0 0 0 ) zone-name1 zone-name2)

Here ( 0 0 0 ) is the location of swirl axis. zone-name1 zone-name2 are the zones from dynamic mesh zones where data is calculated.


Release 18.2 - © ANSYS, Inc. All rights reserved.