structural_mechanics_solver.MechanicalSolver Class Reference

The base class for structural mechanics solvers. More...

Inheritance diagram for structural_mechanics_solver.MechanicalSolver:

Collaboration diagram for structural_mechanics_solver.MechanicalSolver:

Public Member Functions
def	__init__ (self, model, custom_settings)
def	GetDefaultParameters (cls)
def	ValidateSettings (self)
	This function validates the settings of the solver. More...
def	AddVariables (self)
def	GetMinimumBufferSize (self)
def	AddDofs (self)
def	GetDofsList (self)
	This function creates and returns a list with the DOFs defined in the conditions and elements specifications. More...
def	ImportModelPart (self)
	This function imports the ModelPart. More...
def	PrepareModelPart (self)
def	Initialize (self)
	Perform initialization after adding nodal variables and dofs to the main model part. More...
def	InitializeSolutionStep (self)
def	Predict (self)
def	SolveSolutionStep (self)
def	FinalizeSolutionStep (self)
def	AdvanceInTime (self, current_time)
def	ComputeDeltaTime (self)
def	GetComputingModelPart (self)
def	ExportModelPart (self)
def	SetEchoLevel (self, level)
def	Clear (self)
def	Check (self)
def	import_constitutive_laws (self)
def	is_restarted (self)

Public Attributes
	main_model_part
	mpc_block_builder_initialized

Detailed Description

The base class for structural mechanics solvers.

This class provides functions for importing and exporting models,
adding nodal variables and dofs and solving each solution step.

Derived classes must override the function _CreateScheme which
constructs and returns a solution scheme. Depending on the type of
solver, derived classes may also need to override the following functions:

_CreateScheme
_CreateConvergenceCriterion
_CreateLinearSolver
_CreateBuilderAndSolver
_CreateSolutionStrategy

The mechanical_solution_strategy, builder_and_solver, etc. should alway be retrieved
using the getter functions _GetSolutionStrategy, get_builder_and_solver,
etc. from this base class.

Only the member variables listed below should be accessed directly.

Public member variables:
model -- the model containing the modelpart used to construct the solver.
settings -- Kratos parameters containing solver settings.

Constructor & Destructor Documentation

__init__()

def structural_mechanics_solver.MechanicalSolver.__init__	(		self,
			model,
			custom_settings
	)

Member Function Documentation

AddDofs()

def structural_mechanics_solver.MechanicalSolver.AddDofs

(

self

)

AddVariables()

def structural_mechanics_solver.MechanicalSolver.AddVariables

(

self

)

AdvanceInTime()

def structural_mechanics_solver.MechanicalSolver.AdvanceInTime	(		self,
			current_time
	)

Check()

def structural_mechanics_solver.MechanicalSolver.Check

(

self

)

Clear()

def structural_mechanics_solver.MechanicalSolver.Clear

(

self

)

ComputeDeltaTime()

def structural_mechanics_solver.MechanicalSolver.ComputeDeltaTime

(

self

)

ExportModelPart()

def structural_mechanics_solver.MechanicalSolver.ExportModelPart

(

self

)

FinalizeSolutionStep()

def structural_mechanics_solver.MechanicalSolver.FinalizeSolutionStep

(

self

)

GetComputingModelPart()

def structural_mechanics_solver.MechanicalSolver.GetComputingModelPart

(

self

)

GetDefaultParameters()

def structural_mechanics_solver.MechanicalSolver.GetDefaultParameters

(

cls

)

GetDofsList()

def structural_mechanics_solver.MechanicalSolver.GetDofsList

(

self

)

This function creates and returns a list with the DOFs defined in the conditions and elements specifications.

GetMinimumBufferSize()

def structural_mechanics_solver.MechanicalSolver.GetMinimumBufferSize

(

self

)

import_constitutive_laws()

def structural_mechanics_solver.MechanicalSolver.import_constitutive_laws

(

self

)

ImportModelPart()

def structural_mechanics_solver.MechanicalSolver.ImportModelPart

(

self

)

This function imports the ModelPart.

Initialize()

def structural_mechanics_solver.MechanicalSolver.Initialize

(

self

)

Perform initialization after adding nodal variables and dofs to the main model part.

InitializeSolutionStep()

def structural_mechanics_solver.MechanicalSolver.InitializeSolutionStep

(

self

)

is_restarted()

def structural_mechanics_solver.MechanicalSolver.is_restarted

(

self

)

Predict()

def structural_mechanics_solver.MechanicalSolver.Predict

(

self

)

PrepareModelPart()

def structural_mechanics_solver.MechanicalSolver.PrepareModelPart

(

self

)

SetEchoLevel()

def structural_mechanics_solver.MechanicalSolver.SetEchoLevel	(		self,
			level
	)

SolveSolutionStep()

def structural_mechanics_solver.MechanicalSolver.SolveSolutionStep

(

self

)

ValidateSettings()

def structural_mechanics_solver.MechanicalSolver.ValidateSettings

(

self

)

This function validates the settings of the solver.

Member Data Documentation

main_model_part

structural_mechanics_solver.MechanicalSolver.main_model_part

mpc_block_builder_initialized

structural_mechanics_solver.MechanicalSolver.mpc_block_builder_initialized

---

The documentation for this class was generated from the following file:

• /home/runner/work/Documentation/Documentation/master/applications/StructuralMechanicsApplication/python_scripts/structural_mechanics_solver.py