PID.average_field.Averager Class Reference

Collaboration diagram for PID.average_field.Averager:

Public Member Functions
def	__init__ (self, rotation_axis_initial_point, rotation_axis_final_point, angular_velocity_module, dataset_name, original_file_name, original_file_path, initial_time=0.0, end_time=float('inf'), steps_per_average_step=1, calculate_standard_deviations=True, normalize_standard_deviation=True, overwrite_previous=True)
def	IsRelevant (self, i, time_str)
def	GetFilePath (self)
def	PerformAverage (self, reference_time=0.0)

Static Public Member Functions
def	GetLastStationaryFieldId (hdf5_file)
def	CreateGroup (file_or_group, name, overwrite_previous=True)
def	CopyDataset (file_or_group, dset, new_dset_name)
def	ReadVariables (vel, p, hdf5_file, group_name)

Public Attributes
	initial_time
	end_time
	steps_per_average_step
	calculate_standard_deviations
	dataset_name
	original_file_name
	original_file_path
	averaged_field_file_path
	normalize_standard_deviation
	overwrite_previous
	rotator
	reference_time
	times_str
	n_nodes

Constructor & Destructor Documentation

__init__()

def PID.average_field.Averager.__init__	(		self,
			rotation_axis_initial_point,
			rotation_axis_final_point,
			angular_velocity_module,
			dataset_name,
			original_file_name,
			original_file_path,
			initial_time = 0.0,
			end_time = float('inf'),
			steps_per_average_step = 1,
			calculate_standard_deviations = True,
			normalize_standard_deviation = True,
			overwrite_previous = True
	)

Member Function Documentation

CopyDataset()

def PID.average_field.Averager.CopyDataset (   file_or_group,   dset,   new_dset_name  )

static

CreateGroup()

def PID.average_field.Averager.CreateGroup (   file_or_group,   name,   overwrite_previous = True  )

static

GetFilePath()

def PID.average_field.Averager.GetFilePath

(

self

)

GetLastStationaryFieldId()

def PID.average_field.Averager.GetLastStationaryFieldId (   hdf5_file )

static

IsRelevant()

def PID.average_field.Averager.IsRelevant	(		self,
			i,
			time_str
	)

PerformAverage()

def PID.average_field.Averager.PerformAverage	(		self,
			reference_time = 0.0
	)

ReadVariables()

def PID.average_field.Averager.ReadVariables (   vel,   p,   hdf5_file,   group_name  )

static

Member Data Documentation

averaged_field_file_path

PID.average_field.Averager.averaged_field_file_path

calculate_standard_deviations

PID.average_field.Averager.calculate_standard_deviations

dataset_name

PID.average_field.Averager.dataset_name

end_time

PID.average_field.Averager.end_time

initial_time

PID.average_field.Averager.initial_time

n_nodes

PID.average_field.Averager.n_nodes

normalize_standard_deviation

PID.average_field.Averager.normalize_standard_deviation

original_file_name

PID.average_field.Averager.original_file_name

original_file_path

PID.average_field.Averager.original_file_path

overwrite_previous

PID.average_field.Averager.overwrite_previous

reference_time

PID.average_field.Averager.reference_time

rotator

PID.average_field.Averager.rotator

steps_per_average_step

PID.average_field.Averager.steps_per_average_step

times_str

PID.average_field.Averager.times_str

---

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

• /home/runner/work/Documentation/Documentation/master/applications/SwimmingDEMApplication/python_scripts/PID/average_field.py