_Step

class compas_fea2.problem._Step(*args, **kwargs)

Bases: compas_fea2.base.FEAData

Initialises base Step object.

Parameters
namestr, optional

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

Notes

Steps are registered to a compas_fea2.problem.Problem.

A compas_fea2 analysis is based on the concept of steps, which represent the sequence in which the state of the model is modified. Steps can be introduced for example to change the output requests or to change loads, boundary conditions, analysis procedure, etc. There is no limit on the number of steps in an analysis.

Attributes
namestr

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

field_outputs: :class:`compas_fea2.problem.FieldOutput’

Field outuputs requested for the step.

history_outputs: :class:`compas_fea2.problem.HistoryOutput’

History outuputs requested for the step.

resultscompas_fea2.results.StepResults

The results of the analysis at this step

Methods

add_output

Request a field or history output.

Inherited Methods

ToString

Converts the instance to a string.

copy

Make an independent copy of the data object.

data

from_data

Construct an object of this type from the provided data.

from_json

Construct an object from serialized data contained in a JSON file.

from_jsonstring

Construct an object from serialized data contained in a JSON string.

from_name

Create an instance of a class of the registered plugin from its name.

jobdata

Generate the job data for the backend-specific input file.

sha256

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

to_data

Convert an object to its native data representation.

to_json

Serialize the data representation of an object to a JSON file.

to_jsonstring

Serialize the data representation of an object to a JSON string.

validate_data

Validate the object's data against its data schema.

validate_json

Validate the object's data against its json schema.