userdefeltypemodule Module Reference

Module with data types representing user-defined element objects. More...

Data Types
type	userdefeltype
	Data type representing a user-defined element. More...
type	userdefelptrtype
	Data type representing a user-defined element 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(userdefeltype) function, pointer, private	getptrtoiduserdefel (array, id, userId)
	Returns pointer to (first) user-defined element with specified ID. More...
subroutine, private	writeuserdefeltype (elm, io, complexity)
	Standard routine for writing an object to file. More...
subroutine	nullifyuserdefel (elm, deallocating)
	Initializes a user-defined element object. More...
subroutine	deallocateuserdefel (elm)
	Deallocates a user-defined element object. More...
subroutine	deallocateudelms (elms)
	Deallocates all user-defined element object. More...

Detailed Description

Module with data types representing user-defined element objects.

The module also contains subroutines for accessing or manipulating the user-defined element data.

Function/Subroutine Documentation

deallocateudelms()

subroutine userdefeltypemodule::deallocateudelms

(

type(userdefeltype), dimension(:), pointer

elms

)

Deallocates all user-defined element object.

Parameters

elms	Array of all userdefeltypemodule::userdefeltype 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:

deallocateuserdefel()

subroutine userdefeltypemodule::deallocateuserdefel

(

type(userdefeltype), intent(inout)

elm

)

Deallocates a user-defined element object.

Parameters

elm	The userdefeltypemodule::userdefeltype 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:

getptrtoiduserdefel()

type(userdefeltype) function, pointer, private userdefeltypemodule::getptrtoiduserdefel ( type(userdefeltype), dimension(:), intent(in), target  array, integer, intent(in)  id, logical, intent(in), optional  userId  )

private

Returns pointer to (first) user-defined element with specified ID.

Parameters

[in]	array	Array of userdefeltypemodule::userdefeltype objects to search within
[in]	id	Base ID of the object to search for
[in]	userId	If .true., search for a user ID instead

If the user-defined element is not found, NULL is returned.

Author

Knut Morten Okstad

Date

28 Mar 2014

nullifyuserdefel()

subroutine userdefeltypemodule::nullifyuserdefel	(	type(userdefeltype), intent(out)	elm,
		logical, intent(in), optional	deallocating
	)

Initializes a user-defined element object.

Parameters

	elm	The userdefeltypemodule::userdefeltype object to initialize
[in]	deallocating	If .true., the pointers are nullified

Author

Knut Morten Okstad

Date

28 Mar 2014

Here is the caller graph for this function:

writeuserdefeltype()

subroutine, private userdefeltypemodule::writeuserdefeltype ( type(userdefeltype), intent(in)  elm, integer, intent(in)  io, integer, intent(in), optional  complexity  )

private

Standard routine for writing an object to file.

Parameters

[in]	elm	The userdefeltypemodule::userdefeltype object to write
[in]	io	File unit number to write to
[in]	complexity	If present, the value indicates the amount of print

Author

Knut Morten Okstad

Date

28 Mar 2014