analysis_stage.AnalysisStage Class Reference

The base class for the AnalysisStage-classes in the applications Changes to this BaseClass have to be discussed first! More...

Inheritance diagram for analysis_stage.AnalysisStage:

Collaboration diagram for analysis_stage.AnalysisStage:

Public Member Functions
def	__init__ (self, model, project_parameters)
	The constructor of the AnalysisStage-Object. More...
def	Run (self)
	This function executes the entire AnalysisStage It can be overridden by derived classes. More...
def	KeepAdvancingSolutionLoop (self)
	This function specifies the stopping criteria for breaking the solution loop It can be overridden by derived classes. More...
def	RunSolutionLoop (self)
	This function executes the solution loop of the AnalysisStage It can be overridden by derived classes. More...
def	Initialize (self)
	This function initializes the AnalysisStage Usage: It is designed to be called ONCE, BEFORE the execution of the solution-loop This function has to be implemented in deriving classes! More...
def	Finalize (self)
	This function finalizes the AnalysisStage Usage: It is designed to be called ONCE, AFTER the execution of the solution-loop. More...
def	GetFinalData (self)
	Returns the final data dictionary. More...
def	InitializeSolutionStep (self)
	This function performs all the required operations that should be executed (for each step) BEFORE solving the solution step. More...
def	PrintAnalysisStageProgressInformation (self)
def	FinalizeSolutionStep (self)
	This function performs all the required operations that should be executed (for each step) AFTER solving the solution step. More...
def	OutputSolutionStep (self)
	This function printed / writes output files after the solution of a step. More...
def	Check (self)
	This function checks the AnalysisStage. More...
def	Clear (self)
	This function clears the AnalysisStage. More...
def	ModifyInitialProperties (self)
	this is the place to eventually modify material properties in the stage More...
def	ModifyInitialGeometry (self)
	this is the place to eventually modify geometry (for example moving nodes) in the stage More...
def	ModifyAfterSolverInitialize (self)
	this is the place to eventually do any modification that requires the solver to be initialized More...
def	ApplyBoundaryConditions (self)
	here the boundary conditions is applied, by calling the InitializeSolutionStep function of the processes More...
def	ChangeMaterialProperties (self)
	this function is where the user could change material parameters as a part of the solution step More...
None	Save (self, KratosMultiphysics.StreamSerializer serializer)
	Serializes current analysis stage instance. More...
None	Load (self, KratosMultiphysics.StreamSerializer serializer)
	Loads current analysis stage instance. More...

Public Attributes
	model
	project_parameters
	echo_level
	Get echo level and parallel type. More...
	parallel_type
	time
	end_time
	here we initialize user-provided processes More...

Detailed Description

The base class for the AnalysisStage-classes in the applications Changes to this BaseClass have to be discussed first!

Constructor & Destructor Documentation

__init__()

def analysis_stage.AnalysisStage.__init__	(		self,
			model,
			project_parameters
	)

The constructor of the AnalysisStage-Object.

    It is intended to be called from the constructor
    of deriving classes:
    super(DerivedAnalysis, self).__init__(project_parameters)

    Keyword arguments:
    self -- It signifies an instance of a class.
    model -- The Model to be used
    project_parameters -- The ProjectParameters used

Member Function Documentation

ApplyBoundaryConditions()

def analysis_stage.AnalysisStage.ApplyBoundaryConditions

(

self

)

here the boundary conditions is applied, by calling the InitializeSolutionStep function of the processes

ChangeMaterialProperties()

def analysis_stage.AnalysisStage.ChangeMaterialProperties

(

self

)

this function is where the user could change material parameters as a part of the solution step

Check()

def analysis_stage.AnalysisStage.Check

(

self

)

This function checks the AnalysisStage.

    Keyword arguments:
    self -- It signifies an instance of a class.

Clear()

def analysis_stage.AnalysisStage.Clear

(

self

)

This function clears the AnalysisStage.

    Keyword arguments:
    self -- It signifies an instance of a class.

Finalize()

def analysis_stage.AnalysisStage.Finalize

(

self

)

This function finalizes the AnalysisStage Usage: It is designed to be called ONCE, AFTER the execution of the solution-loop.

FinalizeSolutionStep()

def analysis_stage.AnalysisStage.FinalizeSolutionStep

(

self

)

This function performs all the required operations that should be executed (for each step) AFTER solving the solution step.

GetFinalData()

def analysis_stage.AnalysisStage.GetFinalData

(

self

)

Returns the final data dictionary.

    The main purpose of this function is to retrieve any data (in a key-value format) from outside the stage.
    Note that even though it can be called at any point, it is intended to be called at the end of the stage run.

Initialize()

def analysis_stage.AnalysisStage.Initialize

(

self

)

This function initializes the AnalysisStage Usage: It is designed to be called ONCE, BEFORE the execution of the solution-loop This function has to be implemented in deriving classes!

InitializeSolutionStep()

def analysis_stage.AnalysisStage.InitializeSolutionStep

(

self

)

This function performs all the required operations that should be executed (for each step) BEFORE solving the solution step.

KeepAdvancingSolutionLoop()

def analysis_stage.AnalysisStage.KeepAdvancingSolutionLoop

(

self

)

This function specifies the stopping criteria for breaking the solution loop It can be overridden by derived classes.

Load()

None analysis_stage.AnalysisStage.Load	(		self,
		KratosMultiphysics.StreamSerializer	serializer
	)

Loads current analysis stage instance.

    From the given serializer, this method restores current class from a pure Python status (pickable) to the one in the serializer.

ModifyAfterSolverInitialize()

def analysis_stage.AnalysisStage.ModifyAfterSolverInitialize

(

self

)

this is the place to eventually do any modification that requires the solver to be initialized

ModifyInitialGeometry()

def analysis_stage.AnalysisStage.ModifyInitialGeometry

(

self

)

this is the place to eventually modify geometry (for example moving nodes) in the stage

ModifyInitialProperties()

def analysis_stage.AnalysisStage.ModifyInitialProperties

(

self

)

this is the place to eventually modify material properties in the stage

OutputSolutionStep()

def analysis_stage.AnalysisStage.OutputSolutionStep

(

self

)

This function printed / writes output files after the solution of a step.

PrintAnalysisStageProgressInformation()

def analysis_stage.AnalysisStage.PrintAnalysisStageProgressInformation

(

self

)

Run()

def analysis_stage.AnalysisStage.Run

(

self

)

This function executes the entire AnalysisStage It can be overridden by derived classes.

RunSolutionLoop()

def analysis_stage.AnalysisStage.RunSolutionLoop

(

self

)

This function executes the solution loop of the AnalysisStage It can be overridden by derived classes.

Save()

None analysis_stage.AnalysisStage.Save	(		self,
		KratosMultiphysics.StreamSerializer	serializer
	)

Serializes current analysis stage instance.

    This method is intended to make the class pure Python (pickable). This means serialize all the Kratos objects,
    that is to say all the objects coming from Pybind, with the provided serializer. After the serialization, it is
    required to assign None value to all the objects in order to make the class pickable.

Member Data Documentation

echo_level

analysis_stage.AnalysisStage.echo_level

Get echo level and parallel type.

end_time

analysis_stage.AnalysisStage.end_time

here we initialize user-provided processes

Stepping and time settings

model

analysis_stage.AnalysisStage.model

parallel_type

analysis_stage.AnalysisStage.parallel_type

project_parameters

analysis_stage.AnalysisStage.project_parameters

time

analysis_stage.AnalysisStage.time

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/python_scripts/analysis_stage.py