helmholtz_solver_base.HelmholtzSolverBase Class Reference

The base class for Helmholtz-based solvers. More...

Inheritance diagram for helmholtz_solver_base.HelmholtzSolverBase:

Collaboration diagram for helmholtz_solver_base.HelmholtzSolverBase:

Public Member Functions
def	__init__ (self, KratosMultiphysics.Model model, KratosMultiphysics.Parameters custom_settings)
KratosMultiphysics.Parameters	GetDefaultParameters (cls)
float	AdvanceInTime (self, float current_time)
	Public user interface functions ####. More...
None	Initialize (self)
None	InitializeSolutionStep (self)
None	FinalizeSolutionStep (self)
None	Predict (self)
None	SolveSolutionStep (self)
None	SetEchoLevel (self, int level)
int	GetEchoLevel (self)
None	Clear (self)
None	ImportModelPart (self)
KratosMultiphysics.ModelPart	GetComputingModelPart (self)
KratosMultiphysics.ModelPart	GetOriginRootModelPart (self)
KratosMultiphysics.ModelPart	GetOriginModelPart (self)
str	GetFilterType (self)
str	GetFilterRadius (self)

Public Attributes
	filtering_model_part_name
	origin_root_model_part
	helmholtz_model_part
	filter_radius
	filter_type

Detailed Description

The base class for Helmholtz-based solvers.

This class defines the user interface to Helmholtz solvers.

Constructor & Destructor Documentation

__init__()

def helmholtz_solver_base.HelmholtzSolverBase.__init__	(		self,
		KratosMultiphysics.Model	model,
		KratosMultiphysics.Parameters	custom_settings
	)

Member Function Documentation

AdvanceInTime()

float helmholtz_solver_base.HelmholtzSolverBase.AdvanceInTime	(		self,
		float	current_time
	)

Public user interface functions ####.

Clear()

None helmholtz_solver_base.HelmholtzSolverBase.Clear

(

self

)

FinalizeSolutionStep()

None helmholtz_solver_base.HelmholtzSolverBase.FinalizeSolutionStep

(

self

)

GetComputingModelPart()

KratosMultiphysics.ModelPart helmholtz_solver_base.HelmholtzSolverBase.GetComputingModelPart

(

self

)

GetDefaultParameters()

KratosMultiphysics.Parameters helmholtz_solver_base.HelmholtzSolverBase.GetDefaultParameters

(

cls

)

GetEchoLevel()

int helmholtz_solver_base.HelmholtzSolverBase.GetEchoLevel

(

self

)

GetFilterRadius()

str helmholtz_solver_base.HelmholtzSolverBase.GetFilterRadius

(

self

)

GetFilterType()

str helmholtz_solver_base.HelmholtzSolverBase.GetFilterType

(

self

)

GetOriginModelPart()

KratosMultiphysics.ModelPart helmholtz_solver_base.HelmholtzSolverBase.GetOriginModelPart

(

self

)

GetOriginRootModelPart()

KratosMultiphysics.ModelPart helmholtz_solver_base.HelmholtzSolverBase.GetOriginRootModelPart

(

self

)

ImportModelPart()

None helmholtz_solver_base.HelmholtzSolverBase.ImportModelPart

(

self

)

Initialize()

None helmholtz_solver_base.HelmholtzSolverBase.Initialize

(

self

)

InitializeSolutionStep()

None helmholtz_solver_base.HelmholtzSolverBase.InitializeSolutionStep

(

self

)

Predict()

None helmholtz_solver_base.HelmholtzSolverBase.Predict

(

self

)

SetEchoLevel()

None helmholtz_solver_base.HelmholtzSolverBase.SetEchoLevel	(		self,
		int	level
	)

SolveSolutionStep()

None helmholtz_solver_base.HelmholtzSolverBase.SolveSolutionStep

(

self

)

Member Data Documentation

filter_radius

helmholtz_solver_base.HelmholtzSolverBase.filter_radius

filter_type

helmholtz_solver_base.HelmholtzSolverBase.filter_type

filtering_model_part_name

helmholtz_solver_base.HelmholtzSolverBase.filtering_model_part_name

helmholtz_model_part

helmholtz_solver_base.HelmholtzSolverBase.helmholtz_model_part

origin_root_model_part

helmholtz_solver_base.HelmholtzSolverBase.origin_root_model_part

---

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

• /home/runner/work/Documentation/Documentation/master/applications/OptimizationApplication/python_scripts/filtering/helmholtz_solver_base.py