Module with data types representing sensor objects (general function arguments). More...

Data Types
type	sensortype
	Data type representing a sensor object. More...

type	sensorptrtype
	Data type representing a sensor pointer. More...

interface	getptrtoid
	Returns pointer to object with specified ID. More...

interface	writeobject
	Standard routine for writing an object to file. More...

Functions/Subroutines
type(sensortype) function, pointer	getptrtoidsensor (array, id)
	Returns pointer to (first) sensor object with specified ID. More...

subroutine	writesensortype (sensor, lpu, complexity)
	Standard routine for writing an object to file. More...

subroutine	nullifysensor (sensor)
	Initializes a sensor object. More...

subroutine	deallocatesensor (sensor)
	Deallocates a sensor object. More...

subroutine	deallocatesensors (sensors)
	Deallocates all sensor objects. More...

integer function	numctrlout (sensors)
	Returns the number of control output sensors in the model. More...

Variables
character(len=14), dimension(13), parameter	sensortype_p =(/ 'TIME ', 'ENGINE ', 'CONTROL ', 'TRIAD ', 'DAMPER_AXIAL ', 'SPRING_AXIAL ', 'JOINT_VARIABLE', 'SPRING_JOINT ', 'DAMPER_JOINT ', 'RELATIVE_TRIAD', 'MATLAB_WS ', 'STRAIN_GAGE ', 'NUM_ITERATIONS' /)
	Sensor type strings, i.e., what type of object the sensor is measuring. More...

integer, parameter	time_p = 1
	Time sensor enum value. More...

integer, parameter	engine_p = 2
	Engine sensor enum value. More...

integer, parameter	control_p = 3
	Control sensor enum value. More...

integer, parameter	triad_p = 4
	Triad sensor enum value. More...

integer, parameter	damper_axial_p = 5
	Axial sensor damper enum value. More...

integer, parameter	spring_axial_p = 6
	Axial sensor spring enum value. More...

integer, parameter	joint_variable_p = 7
	Joint sensor enum value. More...

integer, parameter	spring_joint_p = 8
	Joint spring sensor enum value. More...

integer, parameter	damper_joint_p = 9
	Joint damper sensor enum value. More...

integer, parameter	relative_triad_p = 10
	Relative sensor enum value. More...

integer, parameter	matlab_ws_p = 11
	Matlab sensor enum value. More...

integer, parameter	strain_gage_p = 12
	Strain gage sensor enum value. More...

integer, parameter	num_iterations_p = 13
	Iterations sensor enum value. More...

character(len=7), dimension(13), parameter	sensorentity_p = (/ 'POS ', 'VEL ', 'ACC ', 'DEFL ', 'FORCE ', 'LENGTH ', 'REL_POS', 'W_SPEED', 'F_VEL ', 'F_ACC ', 'DYN_P ', 'STRAIN ', 'STRESS ' /)
	Sensor entity strings, i.e., which result quantity the sensor is measuring. More...

integer, parameter	pos_p = 1
	Position sensor enum value. More...

integer, parameter	vel_p = 2
	Velocity sensor enum value. More...

integer, parameter	acc_p = 3
	Acceleration sensor enum value. More...

integer, parameter	defl_p = 4
	Deflection sensor enum value. More...

integer, parameter	force_p = 5
	Force sensor enum value. More...

integer, parameter	length_p = 6
	Length sensor enum value. More...

integer, parameter	rel_pos_p = 7
	Relative position sensor enum value. More...

integer, parameter	w_speed_p = 8
	Wind speed sensor enum value. More...

integer, parameter	f_vel_p = 9
	Fluid velocity sensor enum value. More...

integer, parameter	f_acc_p = 10
	Fluid acceleration sensor enum value. More...

integer, parameter	dyn_p_p = 11
	Dynamic pressure sensor enum value. More...

integer, parameter	strain_p = 12
	Strain sensor enum value. More...

integer, parameter	stress_p = 13
	Stress sensor enum value. More...

character(len=6), dimension(2), parameter	sensorsystem_p = (/ 'GLOBAL', 'LOCAL ' /)
	Coordinate system type strings. More...

integer, parameter	global_p = 1
	Global coordinate system enum value. More...

integer, parameter	local_p = 2
	Local coordinate system enum value. More...

type(sensortype), pointer, save	ourtime => null()
	Pointer to the one and only time sensor of the model. More...

Detailed Description

Module with data types representing sensor objects (general function arguments).

The module also contains subroutines for accessing or manipulating the sensor data.

Function/Subroutine Documentation

◆ deallocatesensor()

subroutine sensortypemodule::deallocatesensor ( type(sensortype), intent(inout) sensor )

Deallocates a sensor object.

Parameters

sensor The sensortypemodule::sensortype object to deallocate

Author: Knut Morten Okstad

Date: 23 Jan 2017

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deallocatesensors()

subroutine sensortypemodule::deallocatesensors ( type(sensortype), dimension(:), pointer sensors )

Deallocates all sensor objects.

Parameters

sensors Array of all sensortypemodule::sensortype objects

Author: Knut Morten Okstad

Date: 23 Jan 2017

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getptrtoidsensor()

type(sensortype) function, pointer sensortypemodule::getptrtoidsensor	(	type(sensortype), dimension(:), intent(in), target	array,
		integer, intent(in)	id
	)

Returns pointer to (first) sensor object with specified ID.

Parameters

[in]	array	Array of sensortypemodule::sensortype objects to search within
[in]	id	Base ID of the object to search for

If the sensor is not found, NULL is returned.

Author: Bjorn Haugen

Date: 1 Nov 1999

◆ nullifysensor()

subroutine sensortypemodule::nullifysensor ( type(sensortype), intent(out) sensor )

Initializes a sensor object.

Parameters

sensor The sensortypemodule::sensortype object to initialize

Author: Bjorn Haugen

Date: 10 Sep 1998

Here is the caller graph for this function:

◆ numctrlout()

integer function sensortypemodule::numctrlout ( type(sensortype), dimension(:), intent(in) sensors )

Returns the number of control output sensors in the model.

Parameters

sensors Array of all sensortypemodule::sensortype objects

Author: Knut Morten Okstad

Date: 5 Oct 2006

Here is the caller graph for this function:

◆ writesensortype()

subroutine sensortypemodule::writesensortype	(	type(sensortype), intent(in)	sensor,
		integer, intent(in)	lpu,
		integer, intent(in), optional	complexity
	)

Standard routine for writing an object to file.

Parameters

[in]	sensor	The sensortypemodule::sensortype object to write
[in]	lpu	File unit number to write to
[in]	complexity	If present, the value indicates the amount of print

Author: Bjorn Haugen

Date: 10 Sep 1998

Variable Documentation

◆ acc_p

integer, parameter sensortypemodule::acc_p = 3

Acceleration sensor enum value.

◆ control_p

integer, parameter sensortypemodule::control_p = 3

Control sensor enum value.

◆ damper_axial_p

integer, parameter sensortypemodule::damper_axial_p = 5

Axial sensor damper enum value.

◆ damper_joint_p

integer, parameter sensortypemodule::damper_joint_p = 9

Joint damper sensor enum value.

◆ defl_p

integer, parameter sensortypemodule::defl_p = 4

Deflection sensor enum value.

◆ dyn_p_p

integer, parameter sensortypemodule::dyn_p_p = 11

Dynamic pressure sensor enum value.

◆ engine_p

integer, parameter sensortypemodule::engine_p = 2

Engine sensor enum value.

◆ f_acc_p

integer, parameter sensortypemodule::f_acc_p = 10

Fluid acceleration sensor enum value.

◆ f_vel_p

integer, parameter sensortypemodule::f_vel_p = 9

Fluid velocity sensor enum value.

◆ force_p

integer, parameter sensortypemodule::force_p = 5

Force sensor enum value.

◆ global_p

integer, parameter sensortypemodule::global_p = 1

Global coordinate system enum value.

◆ joint_variable_p

integer, parameter sensortypemodule::joint_variable_p = 7

Joint sensor enum value.

◆ length_p

integer, parameter sensortypemodule::length_p = 6

Length sensor enum value.

◆ local_p

integer, parameter sensortypemodule::local_p = 2

Local coordinate system enum value.

◆ matlab_ws_p

integer, parameter sensortypemodule::matlab_ws_p = 11

Matlab sensor enum value.

◆ num_iterations_p

integer, parameter sensortypemodule::num_iterations_p = 13

Iterations sensor enum value.

◆ ourtime

type(sensortype), pointer, save sensortypemodule::ourtime => null()

Pointer to the one and only time sensor of the model.

◆ pos_p

integer, parameter sensortypemodule::pos_p = 1

Position sensor enum value.

◆ rel_pos_p

integer, parameter sensortypemodule::rel_pos_p = 7

Relative position sensor enum value.

◆ relative_triad_p

integer, parameter sensortypemodule::relative_triad_p = 10

Relative sensor enum value.

◆ sensorentity_p

character(len=7), dimension(13), parameter sensortypemodule::sensorentity_p = (/ 'POS ', 'VEL ', 'ACC ', 'DEFL ', 'FORCE ', 'LENGTH ', 'REL_POS', 'W_SPEED', 'F_VEL ', 'F_ACC ', 'DYN_P ', 'STRAIN ', 'STRESS ' /)

Sensor entity strings, i.e., which result quantity the sensor is measuring.

◆ sensorsystem_p

character(len=6), dimension(2), parameter sensortypemodule::sensorsystem_p = (/ 'GLOBAL', 'LOCAL ' /)

Coordinate system type strings.

◆ sensortype_p

character(len=14), dimension(13), parameter sensortypemodule::sensortype_p =(/ 'TIME ', 'ENGINE ', 'CONTROL ', 'TRIAD ', 'DAMPER_AXIAL ', 'SPRING_AXIAL ', 'JOINT_VARIABLE', 'SPRING_JOINT ', 'DAMPER_JOINT ', 'RELATIVE_TRIAD', 'MATLAB_WS ', 'STRAIN_GAGE ', 'NUM_ITERATIONS' /)

Sensor type strings, i.e., what type of object the sensor is measuring.

◆ spring_axial_p

integer, parameter sensortypemodule::spring_axial_p = 6

Axial sensor spring enum value.

◆ spring_joint_p

integer, parameter sensortypemodule::spring_joint_p = 8

Joint spring sensor enum value.

◆ strain_gage_p

integer, parameter sensortypemodule::strain_gage_p = 12

Strain gage sensor enum value.

◆ strain_p

integer, parameter sensortypemodule::strain_p = 12

Strain sensor enum value.

◆ stress_p

integer, parameter sensortypemodule::stress_p = 13

Stress sensor enum value.

◆ time_p

integer, parameter sensortypemodule::time_p = 1

Time sensor enum value.

◆ triad_p

integer, parameter sensortypemodule::triad_p = 4

Triad sensor enum value.

◆ vel_p

integer, parameter sensortypemodule::vel_p = 2

Velocity sensor enum value.

◆ w_speed_p

integer, parameter sensortypemodule::w_speed_p = 8

Wind speed sensor enum value.

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ deallocatesensor()

◆ deallocatesensors()

◆ getptrtoidsensor()

◆ nullifysensor()

◆ numctrlout()

◆ writesensortype()

Variable Documentation

◆ acc_p

◆ control_p

◆ damper_axial_p

◆ damper_joint_p

◆ defl_p

◆ dyn_p_p

◆ engine_p

◆ f_acc_p

◆ f_vel_p

◆ force_p

◆ global_p

◆ joint_variable_p

◆ length_p

◆ local_p

◆ matlab_ws_p

◆ num_iterations_p

◆ ourtime

◆ pos_p

◆ rel_pos_p

◆ relative_triad_p

◆ sensorentity_p

◆ sensorsystem_p

◆ sensortype_p

◆ spring_axial_p

◆ spring_joint_p

◆ strain_gage_p

◆ strain_p

◆ stress_p

◆ time_p

◆ triad_p

◆ vel_p

◆ w_speed_p