Source code for abaqus.Load.BodyCurrentDensity
from abaqusConstants import *
from .Load import Load
from ..Region.Region import Region
[docs]class BodyCurrentDensity(Load):
"""The BodyCurrentDensity object stores the data for a body current.
The BodyCurrentDensity object is derived from the Load object.
Attributes
----------
name: str
A String specifying the load repository key.
distributionType: SymbolicConstant
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and USER_DEFINED. The default value is UNIFORM.
region: Region
A :py:class:`~abaqus.Region.Region.Region` object specifying the region to which the load is applied.
Notes
-----
This object can be accessed by:
.. code-block:: python
import load
mdb.models[name].loads[name]
"""
# A String specifying the load repository key.
name: str = ''
# A SymbolicConstant specifying how the load is distributed spatially. Possible values are
# UNIFORM and USER_DEFINED. The default value is UNIFORM.
distributionType: SymbolicConstant = UNIFORM
# A Region object specifying the region to which the load is applied.
region: Region = Region()
def __init__(self, name: str, createStepName: str, region: Region, comp1: str, comp2: str, comp3: str,
amplitude: str = UNSET, distributionType: SymbolicConstant = UNIFORM):
"""This method creates a BodyCurrentDensity object.
Notes
-----
This function can be accessed by:
.. code-block:: python
mdb.models[name].BodyCurrentDensity
Parameters
----------
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the
first analysis step name.
region
A Region object specifying the region to which the load is applied.
comp1
A Complex specifying the first component of the load.
comp2
A Complex specifying the second component of the load.
comp3
A Complex specifying the third component of the load.
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.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and USER_DEFINED. The default value is UNIFORM.
Returns
-------
A BodyCurrentDensity object.
"""
super().__init__()
pass
[docs] def setValues(self, amplitude: str = UNSET, distributionType: SymbolicConstant = UNIFORM):
"""This method modifies the data for an existing BodyCurrentDensity object in the step
where it is created.
Parameters
----------
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.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and USER_DEFINED. The default value is UNIFORM.
"""
pass
[docs] def setValuesInStep(self, stepName: str, comp1: str = '', comp2: str = '', comp3: str = '', amplitude: str = ''):
"""This method modifies the propagating data for an existing BodyCurrentDensity object in
the specified step.
Parameters
----------
stepName
A String specifying the name of the step in which the load is modified.
comp1
A Complex specifying the first component of the load.
comp2
A Complex specifying the second component of the load.
comp3
A Complex specifying the third component of the load.
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.
"""
pass