pycba.load_cases.LoadCombination#

class LoadCombination(name, factors, metadata=None)[source]#

Bases: object

Named linear combination of load cases.

factors may be a numeric vector in load-case order, or a mapping keyed by load-case name or zero-based load-case index.

Methods

`analyse`	Analyse this combination as one PyCBA beam analysis.
`analyze`	Analyse this combination as one PyCBA beam analysis.
`envelope`	Analyse this combination and return a plottable `Envelopes`.
`factor_vector`	Return this combination's factors in load-case order.
`response`	Return this combination's response.
`to_LM`	Return the factored PyCBA load matrix for this combination.
`to_load_case`	Return this combination as one ordinary factored `LoadCase`.

Attributes

`metadata`
`name`
`factors`

factor_vector(load_cases=None)[source]#

Return this combination’s factors in load-case order.

Parameters:: load_cases (Optional[LoadCases]) – The basis collection. When omitted, the basis bound by LoadCases.target_combination() is used.
Return type:: ndarray

to_LM(load_cases=None)[source]#

Return the factored PyCBA load matrix for this combination.

Parameters:: load_cases (Optional[LoadCases]) – The basis collection. When omitted, the basis bound by LoadCases.target_combination() is used.
Return type:: List[List[Union[int, float]]]

to_load_case(load_cases=None)[source]#

Return this combination as one ordinary factored LoadCase.

Parameters:: load_cases (Optional[LoadCases]) – The basis collection. When omitted, the basis bound by LoadCases.target_combination() is used.
Return type:: LoadCase

response(load_cases=None, response='M')[source]#

Return this combination’s response.

Parameters:

load_cases (Optional[LoadCases]) – The basis collection. When omitted, the basis bound by LoadCases.target_combination() is used.
response (str) – Station response to return (default "M").

Return type:

tuple[ndarray, ndarray]

analyze(load_cases=None, npts=None)[source]#

Analyse this combination as one PyCBA beam analysis.

Parameters:

load_cases (Optional[LoadCases]) – The basis collection. When omitted, the basis bound by LoadCases.target_combination() is used.
npts (Optional[int]) – Number of evaluation points along a member.

Return type:

BeamAnalysis

analyse(load_cases=None, npts=None)#

Analyse this combination as one PyCBA beam analysis.

Parameters:

load_cases (Optional[LoadCases]) – The basis collection. When omitted, the basis bound by LoadCases.target_combination() is used.
npts (Optional[int]) – Number of evaluation points along a member.

Return type:

BeamAnalysis

envelope(load_cases=None, npts=None)[source]#

Analyse this combination and return a plottable Envelopes.

This lands a target or explicit combination directly on a first-class pycba.results.Envelopes, which can be merged with Envelopes.combine() (or the |/+ operators) and plotted.

Parameters:

load_cases (Optional[LoadCases]) – The basis collection. When omitted, the basis bound by LoadCases.target_combination() is used.
npts (Optional[int]) – Number of evaluation points along a member.

Returns:

A single-result pycba.results.Envelopes for this combination.

Return type:

Envelopes