set_parameter_field_process.SetParameterFieldProcess Class Reference

Sets parameter field process. More...

Inheritance diagram for set_parameter_field_process.SetParameterFieldProcess:

Collaboration diagram for set_parameter_field_process.SetParameterFieldProcess:

Public Member Functions
def	__init__ (self, Model, settings)
def	GetVariableBasedOnString (self)
	This function returns the variable based on the variable name string. More...
def	ExecuteInitialize (self)
	Initializes the process. More...

Public Attributes
	model_part
	params
	process

Detailed Description

Sets parameter field process.

This process has 3 option to generate a custom parameter field:

| option 1, func_type = 'input': with this option, a parameter field is generated based on a function which is directly written in the projectparameters.json at the 'function' parameter. This function can depend on the x, y and z coordinate.

| option 2, func_type = 'python': with this option, a parameter field is generated, using a user defined python script. This python script has to be inherited from the 'ParameterFieldBase' class. Which is located at: 'GeoMechanicsApplication->python_scripts->user_defined_scripts->user_defined_parameter_field_base.py' the name of the script (without '.py') should be filled in at the 'function' parameter in the projectparameters.json

| option 3, func_type = 'json_file': with this option, a parameter field can be directly read from a json dictionary. This dictionary has to contain the 'values' key, which is a 1D list of all the field values. The list has to have the same size as the elements within the model part, and need to be accordingly sorted. The filename should be filled in at the 'dataset' parameter, within the projectparameters.json

Constructor & Destructor Documentation

__init__()

def set_parameter_field_process.SetParameterFieldProcess.__init__	(		self,
			Model,
			settings
	)

Member Function Documentation

ExecuteInitialize()

def set_parameter_field_process.SetParameterFieldProcess.ExecuteInitialize

(

self

)

Initializes the process.

Within the python part of 'ExecuteInitialize', the parameter field with func type 'python' is generate. The cpp part sets the fields on the elements.

Returns

GetVariableBasedOnString()

def set_parameter_field_process.SetParameterFieldProcess.GetVariableBasedOnString

(

self

)

This function returns the variable based on the variable name string.

    Returns
    -------
    variable : KratosMultiphysics.Variable

Member Data Documentation

model_part

set_parameter_field_process.SetParameterFieldProcess.model_part

params

set_parameter_field_process.SetParameterFieldProcess.params

process

set_parameter_field_process.SetParameterFieldProcess.process

---

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

• /home/runner/work/Documentation/Documentation/master/applications/GeoMechanicsApplication/python_scripts/set_parameter_field_process.py