9.29 FluidInletOutletBC object

The FluidInletOutletBC object stores the data for a fluid inlet/outlet boundary condition.

The FluidInletOutletBC object is derived from the BoundaryCondition object.

Access
import load
mdb.models[name].boundaryConditions[name]


9.29.1 FluidInletOutletBC(...)

This method creates a FluidInletOutletBC object.

Path
mdb.models[name].FluidInletOutletBC

Required arguments

name

A String specifying the boundary condition repository key.

createStepName

A String specifying the name of the step in which the boundary condition is created.

region

A Region object specifying the region to which the boundary condition is applied.

Optional arguments

fieldName

A String specifying The name of the AnalyticalField or DiscreteField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD or distributionType=DISCRETE_FIELD. The default value is an empty string.

distributionType

A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, FIELD, and DISCRETE_FIELD. The default value is UNIFORM.

localCsys

None or a DatumCsys object specifying the local coordinate system of the boundary condition's degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

momentumType

A SymbolicConstant specifying the type of boundary condition defined on momentum equation. Possible values are PRESSURE, UNSET and VELOCITY. The default value is UNSET.

pressure

A Float or the SymbolicConstant UNSET specifying the pressure magnitude. Use a numeric value if momentumType=PRESSURE. The default value is UNSET.

v1

A Float or the SymbolicConstant UNSET specifying the velocity component in the 1-direction of the global coordinate system. The default value is UNSET.

Note:  Although v1, v2, v3 are optional arguments, at least one of them must be specified with numeric value when momentumType=VELOCITY.

v2

A Float or the SymbolicConstant UNSET specifying the velocity component in the 2-direction of the global coordinate system. The default value is UNSET.

v3

A Float or the SymbolicConstant UNSET specifying the velocity component in the 3-direction of the global coordinate system. The default value is UNSET.

momentumAmplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that gives the variation of the boundary condition values with time on momentum equation. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET.

temperature

A Float or the SymbolicConstant UNSET specifying the temperature magnitude. The default value is UNSET.

temperatureAmplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that gives the variation of the temperature with time. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET.

kineticEnergy

A Float or the SymbolicConstant UNSET specifying the kinetic energy magnitude. The default value is UNSET.

kineticEnergyAmplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that gives the variation of the kinetic energy with time. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET.

dissipationRate

A Float or the SymbolicConstant UNSET specifying the dissipation rate magnitude. The default value is UNSET.

dissipationRateAmplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that gives the variation of the dissipation rate with time. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET.

eddyViscosity

A Float or the SymbolicConstant UNSET specifying the eddy viscosity magnitude. The default value is UNSET.

eddyViscosityAmplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that gives the variation of the eddy viscosity with time. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET.

Return value

A FluidInletOutletBC object.

Exceptions

None.


9.29.2 setValues(...)

This method modifies the data for an existing FluidInletOutletBC object in the step where it is created.

Required arguments

None.

Optional arguments

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

Return value

None

Exceptions

None.


9.29.3 setValuesInStep(...)

This method modifies the propagating data for an existing FluidInletOutletBC object in the specified step.

Required argument

stepName

A String specifying the name of the step in which the boundary condition is modified.

Optional arguments

momentumType

A SymbolicConstant specifying the type of boundary condition defined on momentum equation. Possible values are FREED, PRESSURE and VELOCITY. Use FREED to remove the previously defined value.

pressure

A Float or the SymbolicConstant FREED specifying the pressure magnitude. Use a numeric value if momentumType=PRESSURE. Otherwise, use FREED to remove the previously defined value.

v1

A Float or the SymbolicConstant FREED specifying the velocity component in the 1-direction of the global coordinate system.

Note:  Although v1, v2, v3 are optional arguments, at least one of them must be specified with numeric value when momentumType=VELOCITY. Otherwise, use FREED to remove the previously defined value.

v2

A Float or the SymbolicConstant FREED specifying the velocity component in the 2-direction of the global coordinate system. Use FREED to remove the previously defined value.

v3

A Float or the SymbolicConstant FREED specifying the velocity component in the 3-direction of the global coordinate system. Use FREED to remove the previously defined value.

momentumAmplitude

A String or the SymbolicConstant FREED specifying the name of the amplitude reference that gives the variation of the boundary condition values with time on momentum equation. FREED should be used if the boundary condition has no amplitude reference.

temperature

A Float or the SymbolicConstant FREED specifying the temperature magnitude. Use FREED to remove the previously defined value.

temperatureAmplitude

A String or the SymbolicConstant FREED specifying the name of the amplitude reference that gives the variation of the temperature with time. FREED should be used if the boundary condition has no amplitude reference.

kineticEnergy

A Float or the SymbolicConstant FREED specifying the kinetic energy magnitude. Use FREED to remove the previously defined value.

kineticEnergyAmplitude

A String or the SymbolicConstant FREED specifying the name of the amplitude reference that gives the variation of the kinetic energy with time. FREED should be used if the boundary condition has no amplitude reference.

dissipationRate

A Float or the SymbolicConstant FREED specifying the dissipation rate magnitude. Use FREED to remove the previously defined value.

dissipationRateAmplitude

A String or the SymbolicConstant FREED specifying the name of the amplitude reference that gives the variation of the dissipation rate with time. FREED should be used if the boundary condition has no amplitude reference.

eddyViscosity

A Float or the SymbolicConstant FREED specifying the eddy viscosity magnitude. Use FREED to remove the previously defined value.

eddyViscosityAmplitude

A String or the SymbolicConstant FREED specifying the name of the amplitude reference that gives the variation of the eddy viscosity with time. FREED should be used if the boundary condition has no amplitude reference.

Return value

None

Exceptions

None.


9.29.4  Members

The FluidInletOutletBC object can have the following members:

name

A String specifying the boundary condition repository key.

distributionType

A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, FIELD, and DISCRETE_FIELD. The default value is UNIFORM.

fieldName

A String specifying The name of the AnalyticalField or DiscreteField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD or distributionType=DISCRETE_FIELD. The default value is an empty string.

category

A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.

region

A Region object specifying the region to which the boundary condition is applied.

localCsys

None or a DatumCsys object specifying the local coordinate system of the boundary condition's degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.