42.5 FluidTurbulence object

The FluidTurbulence object stores the data for fluid turbulence predefined fields. This predefined field is applicable only when a turbulence model has been selected in a flow step.

The FluidTurbulence object is derived from the PredefinedField object.

Access

import load
mdb.models[name].predefinedFields[name]

42.5.1 FluidTurbulence(...)

This method creates aFluidTurbulence object.

Path

mdb.models[name].FluidTurbulence

Required arguments

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the predefined field is created.

region

A Region specifying the domain of the fluid turbulence. Use 'None' to specify the whole model.

Optional arguments

eddyViscosity

A Float specifying the eddy viscosity for the fluid turbulence. This parameter is applicable only when the Spalart-Allmaras turbulence model has been selected in a flow step. The default value is 0.0.

dissipationRate

A Float specifying the dissipation rate for the fluid turbulence. This parameter is applicable only when the k-epsilon renormalization group (RNG) turbulence model has been selected in a flow step. The default value is 0.0.

turbulentKE

A Float specifying the kinetic energy for the fluid turbulence. This parameter is applicable only when the k-epsilon renormalization group (RNG) turbulence model has been selected in a flow step. The default value is 0.0.

Return value

A FluidTurbulence object.

Exceptions

None.

42.5.2 setValues(...)

This method modifies the FluidTurbulence object.

Required arguments

None.

Optional arguments

The optional arguments to setValues are the same as the arguments to the FluidTurbulence method, except for the name and createStepName arguments.

Return value

None

Exceptions

None.

42.5.3 Members

The FluidTurbulence object can have the following members:

name

A String specifying the repository key.

eddyViscosity

A Float specifying the eddy viscosity for the fluid turbulence. This parameter is applicable only when the Spalart-Allmaras turbulence model has been selected in a flow step. The default value is 0.0.

dissipationRate

A Float specifying the dissipation rate for the fluid turbulence. This parameter is applicable only when the k-epsilon renormalization group (RNG) turbulence model has been selected in a flow step. The default value is 0.0.

turbulentKE

A Float specifying the kinetic energy for the fluid turbulence. This parameter is applicable only when the k-epsilon renormalization group (RNG) turbulence model has been selected in a flow step. The default value is 0.0.

region

A Region object specifying the region to which the predefined field is applied.

42.5.4 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=TURBNU, TYPE=TURBKE, TYPE= TURBEPS, ELEMENT AVERAGE