Problem

class compas_fea2.problem.Problem[source]

Bases: FEAData

A Problem is a collection of analysis steps (:class:`compas_fea2.problem._Step) applied in a specific sequence.

Parameters:
namestr, optional

Uniqe identifier. If not provided it is automatically generated. Set a name if you want a more human-readable input file.

describptionstr, optional

Brief description of the Problem, , by default None. This will be added to the input file and can be useful for future reference.

Attributes:
namestr

Uniqe identifier. If not provided it is automatically generated. Set a name if you want a more human-readable input file.

modelcompas_fea2.model.Model

Return the model associated with the problem.

describptionstr

Brief description of the Problem. This will be added to the input file and can be useful for future reference.

stepslist of compas_fea2.problem._Step

List of analysis steps in the order they are applied.

pathstr, pathlib.Path

Path to the analysis folder where all the files will be saved.

path_dbstr, pathlib.Path

Path to the SQLite database where the results are stored.

resultscompas_fea2.results.Results

Results object with the analyisis results.

Warning

Factore Steps are new objects! check the :class:`compas_fea2.problem._Step documentation.

Notes

Problems are registered to a compas_fea2.model.Model.

Problems can also be used as canonical load combinations, where each load is actually a factored step. For example, a typical load combination such as 1.35*DL+1.50LL can be applied to the model by creating the Steps DL and LL, factoring them (see :class:`compas_fea2.problem.Step documentation) and adding them to Problme

While for linear models the sequence of the steps is irrelevant, it is not the case for non-linear models.

Methods

add_linear_static_perturbation_step

Add a linear perturbation step to a previously defined step.

add_static_step

Adds a compas_fea2.problem._Step to the problem.

add_step

Adds a compas_fea2.problem._Step to the problem.

add_steps

Adds multiple compas_fea2.problem._Step objects to the problem.

analyse

Analyse the problem in the selected backend.

analyse_and_extract

Analyse the problem in the selected backend and extract the results from the native database system to SQLite.

analyze

American spelling of the analyse method

extract_results

Extract the results from the native database system to SQLite.

find_step_by_name

Find if there is a step with the given name in the problem.

is_step_in_problem

Check if a compas_fea2.problem._Step is defined in the Problem.

restart_analysis

Continue a previous analysis from a given increement with additional steps.

summary

Prints a summary of the Problem object.

write_input_file

Writes the input file.

Inherited Methods

ToString

Converts the instance to a string.

copy

Make an independent copy of the data object.

from_json

Construct an object of this type from a JSON file.

from_jsonstring

Construct an object of this type from a JSON string.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

to_json

Convert an object to its native data representation and save it to a JSON file.

to_jsonstring

Convert an object to its native data representation and save it to a JSON string.

validate_data

Validate the data against the object's data schema.