environmenttypemodule Module Reference

Module with environment data containers. More...

Data Types
type	environmenttype
	Data type containing some global environmental data. More...
interface	writeobject
	Standard routine for writing an object to file. More...

Functions/Subroutines
subroutine, private	writeenvironmenttype (env, io)
	Standard routine for writing an object to io. More...
subroutine	nullifyenvironment (env)
	Initializes the EnvironmentType object. More...
subroutine	readenvironment (infp, env, err)
	Initializes the environmental data from the solver input file. More...
subroutine	initiateenvironment (env, functions, engines, err)
	Initializes environmental settings after reading the input file. More...
real(dp) function, dimension(3)	glob2sea (env, xg)
	Transforms given global coordinates to the sea coordinate system. More...
subroutine	updategravity (env, time, ierr)
	Updates the scaled gravitation vector in case of dynamic up-ramping. More...

Detailed Description

Module with environment data containers.

This module contains some global parameters and data not associated with the mechanism itself, but the environment it resides in. The data are the used to calculate the external loads on the mechanism that depends on the environment, such as wind, waves, current, etc.

Function/Subroutine Documentation

glob2sea()

real(dp) function, dimension(3) environmenttypemodule::glob2sea	(	type(environmenttype), intent(in)	env,
		real(dp), dimension(3), intent(in)	xg
	)

Transforms given global coordinates to the sea coordinate system.

Parameters

[in]	env	The environmental data of the model
[in]	xg	Spatial coordinates of a point in global coordinate system

Returns

Spatial coordinates of a point in the sea coordinate system

Author

Knut Morten Okstad

Date

20 Feb 2013

Here is the caller graph for this function:

initiateenvironment()

subroutine environmenttypemodule::initiateenvironment	(	type(environmenttype), intent(out)	env,
		type(functiontype), dimension(:), intent(in), target	functions,
		type(enginetype), dimension(:), intent(in), target	engines,
		integer, intent(out)	err
	)

Initializes environmental settings after reading the input file.

Parameters

	env	The environmental data of the model
[in]	functions	All function shapes in the model
[in]	engines	All general functions in the model
[out]	err	Error flag

Author

Knut Morten Okstad

Date

27 Oct 2009

Here is the caller graph for this function:

nullifyenvironment()

subroutine environmenttypemodule::nullifyenvironment

(

type(environmenttype), intent(out)

env

)

Initializes the EnvironmentType object.

Parameters

env	The environmenttypemodule::environmenttype object to initialize

Author

Knut Morten Okstad

Date

5 Oct 2009

Here is the caller graph for this function:

readenvironment()

subroutine environmenttypemodule::readenvironment	(	integer, intent(in)	infp,
		type(environmenttype), intent(out)	env,
		integer, intent(out)	err
	)

Initializes the environmental data from the solver input file.

Parameters

[in]	infp	File unit number for the solver input file
[out]	env	The environmental data of the model
[out]	err	Error flag

Author

Knut Morten Okstad

Date

27 Oct 2009

Here is the caller graph for this function:

updategravity()

subroutine environmenttypemodule::updategravity	(	type(environmenttype), intent(inout)	env,
		real(dp), intent(in)	time,
		integer, intent(out)	ierr
	)

Updates the scaled gravitation vector in case of dynamic up-ramping.

Parameters

	env	The environmental data of the model
[in]	time	Current simulation time
[out]	ierr	Error flag

Author

Knut Morten Okstad

Date

22 Aug 2022

Here is the call graph for this function:

Here is the caller graph for this function:

writeenvironmenttype()

subroutine, private environmenttypemodule::writeenvironmenttype ( type(environmenttype), intent(in)  env, integer, intent(in)  io  )

private

Standard routine for writing an object to io.

Parameters

[in]	env	The environmenttypemodule::environmenttype object to write
[in]	io	File unit number to write to

Author

Knut Morten Okstad

Date

5 Oct 2009