assign_scalar_variable_process.AssignScalarVariableProcess Class Reference

This process sets a given scalar value for a certain variable in all the nodes of a submodelpart. More...

Inheritance diagram for assign_scalar_variable_process.AssignScalarVariableProcess:

Collaboration diagram for assign_scalar_variable_process.AssignScalarVariableProcess:

Public Member Functions
def	__init__ (self, Model, settings)
	The default constructor of the class. More...
def	ExecuteBeforeSolutionLoop (self)
	This method is executed in before initialize the solution step. More...
def	ExecuteInitializeSolutionStep (self)
	This method is executed in order to initialize the current step. More...
def	ExecuteFinalizeSolutionStep (self)
	This method is executed in order to finalize the current step. More...

Public Attributes
	interval
	variable
	model_part
	mesh
	is_fixed
	value_is_numeric
	value_is_function
	value
	function_string
	aux_function
	cpp_apply_function_utility
	table
	variable_utils
	step_is_active

Detailed Description

This process sets a given scalar value for a certain variable in all the nodes of a submodelpart.

Only the member variables listed below should be accessed directly.

Public member variables:
Model -- the container of the different model parts.
settings -- Kratos parameters containing solver settings.

Possible specifications for the key 'value' from settings:
- double: the constant value is applied. Example: 1.0
- string: the string is parsed as a function. Example: "(x*sin(y))*exp(-t^2)"
- parameters: a csv table can be specified. Example:
    {
        "name"       : "csv_table",
        "filename"   : "path/to/file.csv",
        "delimiter"  : ",",
        "skiprows"   : 0,
    }

Constructor & Destructor Documentation

__init__()

def assign_scalar_variable_process.AssignScalarVariableProcess.__init__	(		self,
			Model,
			settings
	)

The default constructor of the class.

   Keyword arguments:
   self -- It signifies an instance of a class.
   Model -- the container of the different model parts.
   settings -- Kratos parameters containing solver settings.

Member Function Documentation

ExecuteBeforeSolutionLoop()

def assign_scalar_variable_process.AssignScalarVariableProcess.ExecuteBeforeSolutionLoop

(

self

)

This method is executed in before initialize the solution step.

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

ExecuteFinalizeSolutionStep()

def assign_scalar_variable_process.AssignScalarVariableProcess.ExecuteFinalizeSolutionStep

(

self

)

This method is executed in order to finalize the current step.

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

ExecuteInitializeSolutionStep()

def assign_scalar_variable_process.AssignScalarVariableProcess.ExecuteInitializeSolutionStep

(

self

)

This method is executed in order to initialize the current step.

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

Member Data Documentation

aux_function

assign_scalar_variable_process.AssignScalarVariableProcess.aux_function

cpp_apply_function_utility

assign_scalar_variable_process.AssignScalarVariableProcess.cpp_apply_function_utility

function_string

assign_scalar_variable_process.AssignScalarVariableProcess.function_string

interval

assign_scalar_variable_process.AssignScalarVariableProcess.interval

is_fixed

assign_scalar_variable_process.AssignScalarVariableProcess.is_fixed

mesh

assign_scalar_variable_process.AssignScalarVariableProcess.mesh

model_part

assign_scalar_variable_process.AssignScalarVariableProcess.model_part

step_is_active

assign_scalar_variable_process.AssignScalarVariableProcess.step_is_active

table

assign_scalar_variable_process.AssignScalarVariableProcess.table

value

assign_scalar_variable_process.AssignScalarVariableProcess.value

value_is_function

assign_scalar_variable_process.AssignScalarVariableProcess.value_is_function

value_is_numeric

assign_scalar_variable_process.AssignScalarVariableProcess.value_is_numeric

variable

assign_scalar_variable_process.AssignScalarVariableProcess.variable

variable_utils

assign_scalar_variable_process.AssignScalarVariableProcess.variable_utils

---

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

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