_GeneralStep

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

Bases: compas_fea2.problem.steps.step._Step

General Step object for use as a base class in a general static, dynamic or multiphysics analysis.

Parameters
max_incrementsint

Max number of increments to perform during the case step. (Typically 100 but you might have to increase it in highly non-linear problems. This might increase the analysis time.).

initial_inc_sizefloat

Sets the the size of the increment for the first iteration. (By default is equal to the total time, meaning that the software decrease the size automatically.)

min_inc_sizefloat

Minimum increment size before stopping the analysis. (By default is 1e-5, but you can set a smaller size for highly non-linear problems. This might increase the analysis time.)

timefloat

Total time of the case step. Note that this not actual ‘time’, but rather a proportionality factor. (By default is 1, meaning that the analysis is complete when all the increments sum up to 1)

nlgeombool

if True nonlinear geometry effects are considered.

modifybool

if True the loads applied in a previous step are substituted by the ones defined in the present step, otherwise the loads are added.

restartfloat, optional

Frequency at which saving the results for restarting the analysis, by default False.

Attributes
namestr

Automatically generated id. You can change the name if you want a more human readable input file.

max_incrementsint

Max number of increments to perform during the case step. (Typically 100 but you might have to increase it in highly non-linear problems. This might increase the analysis time.).

initial_inc_sizefloat

Sets the the size of the increment for the first iteration. (By default is equal to the total time, meaning that the software decrease the size automatically.)

min_inc_sizefloat

Minimum increment size before stopping the analysis. (By default is 1e-5, but you can set a smaller size for highly non-linear problems. This might increase the analysis time.)

timefloat

Total time of the case step. Note that this not actual ‘time’, but rather a proportionality factor. (By default is 1, meaning that the analysis is complete when all the increments sum up to 1)

nlgeombool

if True nonlinear geometry effects are considered.

modifybool

if True the loads applied in a previous step are substituted by the ones defined in the present step, otherwise the loads are added.

restartfloat

Frequency at which saving the results for restarting the analysis.

loadsdict

Dictionary of the loads assigned to each part in the model in the step.

fieldsdict

Dictionary of the prescribed fields assigned to each part in the model in the step.

Inherited Methods

ToString

Converts the instance to a string.

add_output

Request a field or history output.

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.