ComponentAccelerationSetup#

Qualified name: loads.component_acceleration.api.component_acceleration_api.ComponentAccelerationSetup

class loads.component_acceleration.api.component_acceleration_api.ComponentAccelerationSetup(item)[source]#

Bases: LoadSetup, TranslationSettableMixin, RotationSettableMixin

The API handler for component accelerations

The following example shows how to create a component acceleration using the API, it is assumed that these steps were performed in each of the examples for other methods in this class.

Example

>>> from more.api import ApiGateway
>>> api = ApiGateway(proj=proj)
>>> simulation_setup = api.create_simulation_setup()
>>> lcc_setup = simulation_setup.create_load_case_container_setup().set_name(name='Example LCC')
>>> lc_setup = lcc_setup.create_load_case_setup(lc_type='Mechanical load case').set_name(name='Example LC')
>>> component_acceleration_setup = lc_setup.create_load_setup(load_type='Component acceleration')

The next example shows how to get an API object for an already existing load.

Example

>>> from more.api import ApiGateway
>>> api = ApiGateway(proj=proj)
>>> simulation_setup = api.create_simulation_setup()
>>> lcc_setup = simulation_setup.create_load_case_container_setup().set_name(name='Example LCC')
>>> lc_setup = lcc_setup.create_load_case_setup(lc_type='Mechanical load case').set_name(name='Example LC')
>>> component_acceleration_setup = lc_setup.get_load_setup(index=0) # The load under this index must already exist

Methods

set_component

Deprecated method

set_component_by_name

Sets the component for the associated component acceleration

set_dof

Sets the value of an element of the DOF vector

set_dof_dict

Sets the values of the load vector to those given in the dictionary

set_ru

Sets the 'ru' value of the load vector

set_rv

Sets the 'rv' value of the load vector

set_rw

Sets the 'rw' value of the load vector

set_u

Sets the 'u' value of the load vector

set_v

Sets the 'v' value of the load vector

set_w

Sets the 'w' value of the load vector

set_component(component) ComponentAccelerationSetup[source]#

Deprecated method

Deprecated

set_component will be removed in a future MORe release, it is replaced by set_component_by_name()

set_component_by_name(component_name: str) ComponentAccelerationSetup[source]#

Sets the component for the associated component acceleration

See example at the top for how to create a component acceleration setup object

Example

>>> component_acceleration_setup = component_acceleration_setup.set_component_by_name(component_name='example component') # The component with this name must already exist
Returns:

self

Return type:

ComponentAccelerationSetup

Raises:

NameNotFoundError – Raised if there is no component with the supplied name

set_dof(dof_name, value) ComponentAccelerationSetup[source]#

Sets the value of an element of the DOF vector

See example at the top for how to create the setup object

Example

>>> component_acceleration_setup = component_acceleration_setup.set_dof(dof_name='v', value=10)
Returns:

self

Return type:

ComponentAccelerationSetup

Raises:
  • TypeError – Raised if the supplied value is not a floating point number

  • NameNotFoundError – Raised if the given name is not a recognized DOF

set_dof_dict(dof_values_dict: Dict[str, float]) ComponentAccelerationSetup[source]#

Sets the values of the load vector to those given in the dictionary

See example at the top for how to create a component acceleration setup object

Example

>>> component_acceleration_setup = component_acceleration_setup.set_dof_dict(dof_values_dict={'u': 5, 'ru': 10, 'v': 2.0})
Returns:

self

Return type:

ComponentAccelerationSetup

Raises:
  • TypeError – Raised if the supplied value is not a floating point number

  • NameNotFoundError – Raised if a key in the supplied dictionary is not a recognized dof

set_ru(value: float) ComponentAccelerationSetup[source]#

Sets the ‘ru’ value of the load vector

See example at the top for how to create a component acceleration setup object

Example

>>> component_acceleration_setup = component_acceleration_setup.set_ru(value=10)
Returns:

self

Return type:

ComponentAccelerationSetup

Raises:

TypeError – Raised if the supplied value is not a floating point number

set_rv(value: float) ComponentAccelerationSetup[source]#

Sets the ‘rv’ value of the load vector

See example at the top for how to create a component acceleration setup object

Example

>>> component_acceleration_setup = component_acceleration_setup.set_rv(value=10)
Returns:

self

Return type:

ComponentAccelerationSetup

Raises:

TypeError – Raised if the supplied value is not a floating point number

set_rw(value: float) ComponentAccelerationSetup[source]#

Sets the ‘rw’ value of the load vector

See example at the top for how to create a component acceleration setup object

Example

>>> component_acceleration_setup = component_acceleration_setup.set_rw(value=10)
Returns:

self

Return type:

ComponentAccelerationSetup

Raises:

TypeError – Raised if the supplied value is not a floating point number

set_u(value: float) ComponentAccelerationSetup[source]#

Sets the ‘u’ value of the load vector

See example at the top for how to create a component acceleration setup object

Example

>>> component_acceleration_setup = component_acceleration_setup.set_u(value=10)
Returns:

self

Return type:

ComponentAccelerationSetup

Raises:

TypeError – Raised if the supplied value is not a floating point number

set_v(value: float) ComponentAccelerationSetup[source]#

Sets the ‘v’ value of the load vector

See example at the top for how to create a component acceleration setup object

Example

>>> component_acceleration_setup = component_acceleration_setup.set_v(value=10)
Returns:

self

Return type:

ComponentAccelerationSetup

Raises:

TypeError – Raised if the supplied value is not a floating point number

set_w(value: float) ComponentAccelerationSetup[source]#

Sets the ‘w’ value of the load vector

See example at the top for how to create a component acceleration setup object

Example

>>> component_acceleration_setup = component_acceleration_setup.set_w(value=10)
Returns:

self

Return type:

ComponentAccelerationSetup

Raises:

TypeError – Raised if the supplied value is not a floating point number