LinkLoadSetup#

Qualified name: loads.link_load.api.link_load_api.LinkLoadSetup

Bases: LoadSetup, TranslationSettableMixin, RotationSettableMixin

The API handler for link loads

The following example shows how to create a link load 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')
>>> link_load_setup = lc_setup.create_load_setup(load_type='Link load')

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')
>>> link_load_setup = lc_setup.get_load_setup(index=0) # The load under this index must already exist

Methods

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_link

Deprecated method

set_link_by_name

Sets the link for the associated link load

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

Sets the value of an element of the DOF vector

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

Example

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

self

Return type:

LinkLoadSetup

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

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

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

See example at the top for how to create a link load setup object

Example

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

self

Return type:

LinkLoadSetup

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

Deprecated method

Deprecated

set_link will be removed in a future MORe release, it is replaced by set_link_by_name()

Sets the link for the associated link load

See example at the top for how to create a link load setup object

Example

>>> link_load_setup = link_load_setup.set_link_by_name(link_name='example link') # The link with this name must already exist
Returns:

self

Return type:

LinkLoadSetup

Raises:

NameNotFoundError – Raised if the supplied link name was not found

Sets the ‘ru’ value of the load vector

See example at the top for how to create a link load setup object

Example

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

self

Return type:

LinkLoadSetup

Raises:

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

Sets the ‘rv’ value of the load vector

See example at the top for how to create a link load setup object

Example

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

self

Return type:

LinkLoadSetup

Raises:

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

Sets the ‘rw’ value of the load vector

See example at the top for how to create a link load setup object

Example

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

self

Return type:

LinkLoadSetup

Raises:

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

Sets the ‘u’ value of the load vector

See example at the top for how to create a link load setup object

Example

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

self

Return type:

LinkLoadSetup

Raises:

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

Sets the ‘v’ value of the load vector

See example at the top for how to create a link load setup object

Example

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

self

Return type:

LinkLoadSetup

Raises:

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

Sets the ‘w’ value of the load vector

See example at the top for how to create a link load setup object

Example

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

self

Return type:

LinkLoadSetup

Raises:

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