The VelocityBC object stores the data for a velocity boundary condition.
The VelocityBC object is derived from the BoundaryCondition object.
import load mdb.models[name].boundaryConditions[name]
This method creates a VelocityBC object.
mdb.models[name].VelocityBC
Required arguments
A String specifying the boundary condition repository key.
A String specifying the name of the step in which the boundary condition is created.
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.
A Float or a SymbolicConstant specifying the velocity component in the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
Note: Although v1, v2, v3, vr1, vr2, and vr3 are optional arguments, at least one of them must be specified.
A Float or a SymbolicConstant specifying the velocity component in the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
A Float or a SymbolicConstant specifying the velocity component in the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
A Float or a SymbolicConstant specifying the rotational velocity component about the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
A Float or a SymbolicConstant specifying the rotational velocity component about the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
A Float or a SymbolicConstant specifying the rotational velocity component about the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
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.
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
Return value
A VelocityBC object.
Exceptions
This method modifies the data for an existing VelocityBC object in the step where it is created.
Required arguments
Optional arguments
The optional arguments to setValues are the same as the arguments to the VelocityBC method, except for the name and createStepName arguments.
Return value
Exceptions
This method modifies the propagating data for an existing VelocityBC object in the specified step.
Required argument
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
A Float or a SymbolicConstant specifying the velocity component in the 1-direction. Possible values for the SymbolicConstant are SET and FREED.
A Float or a SymbolicConstant specifying the velocity component in the 2-direction. Possible values for the SymbolicConstant are SET and FREED.
A Float or a SymbolicConstant specifying the velocity component in the 3-direction. Possible values for the SymbolicConstant are SET and FREED.
A Float or a SymbolicConstant specifying the rotational velocity component about the 1-direction. Possible values for the SymbolicConstant are SET and FREED.
A Float or a SymbolicConstant specifying the rotational velocity component about the 2-direction. Possible values for the SymbolicConstant are SET and FREED.
A Float or a SymbolicConstant specifying the rotational velocity component about the 3-direction. Possible values for the SymbolicConstant are SET and FREED.
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous analysis step. FREED should be used if the boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.
Return value
Exceptions
The VelocityBC object can have the following members:
A String specifying the boundary condition repository key.
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.
A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
A Region object specifying the region to which the boundary condition is applied.
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.