27.33 Gravity object

The Gravity object stores the data of a gravity load.

The Gravity object is derived from the Load object.

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


27.33.1 Gravity(...)

This method creates a Gravity object.

Path
mdb.models[name].Gravity

Required arguments

name

A String specifying the load repository key.

createStepName

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

Optional arguments

distributionType

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType=FIELD. The default value is an empty string.

region

A Region object specifying the region to which the load is applied.

comp1

A Float or a Complex specifying the component of the load in the 1-direction.

Note:  Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero.

comp2

A Float or a Complex specifying the component of the load in the 2-direction.

comp3

A Float or a Complex specifying the component of the load in the 3-direction.

amplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Return value

A Gravity object.

Exceptions

None.


27.33.2 setValues(...)

This method modifies the data for an existing Gravity 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 Gravity method, except for the name and createStepName arguments.

Return value

None

Exceptions

None.


27.33.3 setValuesInStep(...)

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

Required argument

stepName

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

Optional arguments

comp1

A Float, a Complex, or a SymbolicConstant specifying the load component in the 1-direction. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the load component is propagated from the previous static analysis step. Use FREED to remove a previously defined load component.

comp2

A Float, a Complex, or a SymbolicConstant specifying the load component in the 2-direction. For details see comp1.

comp3

A Float, a Complex, or a SymbolicConstant specifying the load component in the 3-direction. For details see comp1.

amplitude

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 static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

Return value

None

Exceptions

None.


27.33.4  Members

The Gravity object can have the following members:

name

A String specifying the load repository key.

distributionType

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType=FIELD. The default value is an empty string.

region

A Region object specifying the region to which the load is applied.