helmholtz_analysis.HelmholtzAnalysis Class Reference

This class is the main-script of the implicit filtering analysis It can be imported and used as "black-box". More...

Inheritance diagram for helmholtz_analysis.HelmholtzAnalysis:

Collaboration diagram for helmholtz_analysis.HelmholtzAnalysis:

Public Member Functions
def	__init__ (self, KM.Model model, KM.Parameters project_parameters)
def	Initialize (self)
	Public user interface functions ####. More...
def	SetFilterRadius (self, float filter_radius)
def	SetBulkFilterRadius (self)
def	RunSolver (self)
ContainerExpressionTypes	FilterField (self, ContainerExpressionTypes unfiltered_field)
ContainerExpressionTypes	FilterIntegratedField (self, ContainerExpressionTypes unfiltered_field)
ContainerExpressionTypes	UnFilterField (self, ContainerExpressionTypes filtered_field)

Detailed Description

This class is the main-script of the implicit filtering analysis It can be imported and used as "black-box".

Constructor & Destructor Documentation

__init__()

def helmholtz_analysis.HelmholtzAnalysis.__init__	(		self,
		KM.Model	model,
		KM.Parameters	project_parameters
	)

Member Function Documentation

FilterField()

ContainerExpressionTypes helmholtz_analysis.HelmholtzAnalysis.FilterField	(		self,
		ContainerExpressionTypes	unfiltered_field
	)

FilterIntegratedField()

ContainerExpressionTypes helmholtz_analysis.HelmholtzAnalysis.FilterIntegratedField	(		self,
		ContainerExpressionTypes	unfiltered_field
	)

Initialize()

def helmholtz_analysis.HelmholtzAnalysis.Initialize

(

self

)

Public user interface functions ####.

RunSolver()

def helmholtz_analysis.HelmholtzAnalysis.RunSolver

(

self

)

SetBulkFilterRadius()

def helmholtz_analysis.HelmholtzAnalysis.SetBulkFilterRadius

(

self

)

SetFilterRadius()

def helmholtz_analysis.HelmholtzAnalysis.SetFilterRadius	(		self,
		float	filter_radius
	)

UnFilterField()

ContainerExpressionTypes helmholtz_analysis.HelmholtzAnalysis.UnFilterField	(		self,
		ContainerExpressionTypes	filtered_field
	)

---

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

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