Module with subroutines for user-defined element calculations. More...

Functions/Subroutines
subroutine	initializeude (elmId, etype, nedof, triads, iwork, rwork, ierr)
	Initializes a user-defined element. More...

subroutine, private	updateude (elmId, etype, nedof, triads, engines, iwork, rwork, hydyn, envir, K, C, M, Fs, Fd, Fi, Q, Tlg, t, dt, istep, iter, ierr)
	Updates a user-defined element. More...

subroutine	updateudes (elms, env, time, timeStep, istep, iter, ierr)
	Updates all user-defined elements in the model. More...

subroutine, private	calcmorisonforces (elmId, nedof, triads, Tlg, urd, urdd, C, M, Q, hydyn, envir, time, istep, iter, ierr)
	Calculates Morison force contributions for a two-noded element. More...

subroutine, private	calcbuoyancyforces (elmId, nedof, triads, Tlg, Q, hydyn, envir, time, iter, ierr)
	Calculates buoyancy force contributions for a two-noded element. More...

subroutine	addinudeforces (sam, elms, FSk, FDk, FIk, Qk, RFk, ierr)
	Adds element forces into corresponding system force vectors. More...

subroutine	addinstaticudeforces (sam, elms, FSk, Qk, RFk, ierr)
	Adds static element forces into corresponding system force vectors. More...

subroutine	addinudemat (udeMat, sysMat, elm, sam, ierr, sysRhs)
	Adds an element matrix into the equivalent system matrix. More...

subroutine	buildudenewtonmat (scaleM, scaleC, scaleK, elm, ierr)
	Computes the user-defined element Newton matrix. More...

Detailed Description

Module with subroutines for user-defined element calculations.

This module contains a set of subroutines for performing various computation tasks on the userdefeltypemodule::userdefeltype objects in the model during the dynamic or quasi-static simulation.

Function/Subroutine Documentation

◆ addinstaticudeforces()

subroutine userdefelroutinesmodule::addinstaticudeforces	(	type(samtype), intent(in)	sam,
		type(userdefeltype), dimension(:), intent(in)	elms,
		real(dp), dimension(:), intent(inout)	FSk,
		real(dp), dimension(:), intent(inout)	Qk,
		real(dp), dimension(:), intent(inout)	RFk,
		integer, intent(out)	ierr
	)

Adds static element forces into corresponding system force vectors.

Parameters

[in]	sam	Data for managing system matrix assembly
[in]	elms	All user-defined elements in the model
	FSk	Internal stiffness force vector
	Qk	External force vector (gravitation loads)
	RFk	Reaction forces
[out]	ierr	Error flag

Author: Knut Morten Okstad

Date: 28 Mar 2014

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addinudeforces()

subroutine userdefelroutinesmodule::addinudeforces	(	type(samtype), intent(in)	sam,
		type(userdefeltype), dimension(:), intent(in)	elms,
		real(dp), dimension(:), intent(inout)	FSk,
		real(dp), dimension(:), intent(inout)	FDk,
		real(dp), dimension(:), intent(inout)	FIk,
		real(dp), dimension(:), intent(inout)	Qk,
		real(dp), dimension(:), intent(inout)	RFk,
		integer, intent(out)	ierr
	)

Adds element forces into corresponding system force vectors.

Parameters

[in]	sam	Data for managing system matrix assembly
[in]	elms	All user-defined elements in the model
	FSk	Internal stiffness force vector
	FDk	Internal damping force vector
	FIk	Internal inertia force vector
	Qk	External force vector (gravitation loads)
	RFk	Reaction forces
[out]	ierr	Error flag

Author: Knut Morten Okstad

Date: 28 Mar 2014

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addinudemat()

subroutine userdefelroutinesmodule::addinudemat	(	real(dp), dimension(:,:), intent(in)	udeMat,
		type(sysmatrixtype), intent(inout)	sysMat,
		type(userdefeltype), intent(in)	elm,
		type(samtype), intent(in)	sam,
		integer, intent(out)	ierr,
		real(dp), dimension(:), intent(inout), optional	sysRhs
	)

Adds an element matrix into the equivalent system matrix.

Parameters

[in]	udeMat	The element matrix to add into the system
	sysMat	System coefficiant matrix (stiffness, mass, ...)
[in]	elm	The user-defined element the matrix is associated with
[in]	sam	Data for managing system matrix assembly
[out]	ierr	Error flag
	sysRhs	System right-hand-side vector

This subroutine transforms the user-defined element matrix udeMat to the system directions for each DOF associated with it, and then adds it into the corresponding system matrix sysMat. If any of the element DOFs are prescribed, the associated force contributions are added into the system force vector sysRhs, if present.

Author: Knut Morten Okstad

Date: 28 Mar 2014

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildudenewtonmat()

subroutine userdefelroutinesmodule::buildudenewtonmat	(	real(dp), intent(in)	scaleM,
		real(dp), intent(in)	scaleC,
		real(dp), intent(in)	scaleK,
		type(userdefeltype), intent(inout)	elm,
		integer, intent(out)	ierr
	)

Computes the user-defined element Newton matrix.

Parameters

[in]	scaleM	Mass matrix scaling factor
[in]	scaleC	Damping matrix scaling factor
[in]	scaleK	Stiffness matrix scaling factor
	elm	The user-defined element to compute Newton matrix for
[out]	ierr	Error flag

The Newton matrix is a linear combination of the stiffness-, damping- (if any) and stiffness matrices of the user-defined element.

Author: Knut Morten Okstad

Date: 28 Mar 2014

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcbuoyancyforces()

subroutine, private userdefelroutinesmodule::calcbuoyancyforces	(	character(len=*), intent(in)	elmId,
		integer, intent(in)	nedof,
		type(triadptrtype), dimension(:), intent(in)	triads,
		real(dp), dimension(:,:), intent(in)	Tlg,
		real(dp), dimension(:), intent(inout)	Q,
		type(hydrodyntype), intent(inout)	hydyn,
		type(environmenttype), intent(inout)	envir,
		real(dp), intent(in)	time,
		integer, intent(in)	iter,
		integer, intent(inout)	ierr
	)

private

Calculates buoyancy force contributions for a two-noded element.

Parameters

[in]	elmId	ID string of the element to calculate for
[in]	nedof	Dimension of the element matrices
[in]	triads	The triads connected to this user-defined element
[in]	Tlg	Local-to-global transformation matrix for the element
	Q	External element forces
	hydyn	Data for hydrodynamic force calculation for this element
	envir	Environmental data
[in]	time	Current simulation time
[in]	iter	Iteration counter
[out]	ierr	Error flag

Author: Knut Morten Okstad

Date: 30 Sep 2019

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcmorisonforces()

subroutine, private userdefelroutinesmodule::calcmorisonforces	(	character(len=*), intent(in)	elmId,
		integer, intent(in)	nedof,
		type(triadptrtype), dimension(:), intent(in)	triads,
		real(dp), dimension(:,:), intent(in)	Tlg,
		real(dp), dimension(:), intent(in)	urd,
		real(dp), dimension(:), intent(in)	urdd,
		real(dp), dimension(:,:), intent(inout)	C,
		real(dp), dimension(:,:), intent(inout)	M,
		real(dp), dimension(:), intent(inout)	Q,
		type(hydrodyntype), intent(inout)	hydyn,
		type(environmenttype), intent(inout)	envir,
		real(dp), intent(in)	time,
		integer, intent(in)	istep,
		integer, intent(in)	iter,
		integer, intent(inout)	ierr
	)

private

Calculates Morison force contributions for a two-noded element.

Parameters

[in]	elmId	ID string of the element to calculate for
[in]	nedof	Dimension of the element matrices
[in]	triads	The triads connected to this user-defined element
[in]	Tlg	Local-to-global transformation matrix for the element
[in]	urd	Element velocity vector, in global coordinates
[in]	urdd	Element acceleration vector, in global coordinates
	C	Element damping matrix
	M	Element mass matrix
	Q	External element forces
	hydyn	Data for hydrodynamic force calculation for this element
	envir	Environmental data
[in]	time	Current simulation time
[in]	istep	Time increment counter
[in]	iter	Iteration counter
[out]	ierr	Error flag

Author: Knut Morten Okstad

Date: 30 Sep 2019

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initializeude()

subroutine userdefelroutinesmodule::initializeude	(	type(idtype), intent(in)	elmId,
		integer, intent(in)	etype,
		integer, intent(in)	nedof,
		type(triadptrtype), dimension(:), intent(in)	triads,
		integer, dimension(:), pointer	iwork,
		real(dp), dimension(:), pointer	rwork,
		integer, intent(out)	ierr
	)

Initializes a user-defined element.

Parameters

[in]	elmId	Id of the user-defined element to initialize
[in]	etype	User-defined element type flag
[in]	nedof	Dimension of the element matrices
[in]	triads	The triads connected to this user-defined element
	iwork	Integer work array for this user-defined element
	rwork	Real work array for this user-defined element
[out]	ierr	Error flag

Author: Knut Morten Okstad

Date: 28 Mar 2014

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateude()

subroutine, private userdefelroutinesmodule::updateude	(	type(idtype), intent(in)	elmId,
		integer, intent(in)	etype,
		integer, intent(in)	nedof,
		type(triadptrtype), dimension(:), intent(in)	triads,
		type(engineptrtype), dimension(:), intent(in)	engines,
		integer, dimension(:), intent(inout)	iwork,
		real(dp), dimension(:), intent(inout)	rwork,
		type(hydrodyntype), pointer	hydyn,
		type(environmenttype), intent(inout)	envir,
		real(dp), dimension(:,:), intent(out)	K,
		real(dp), dimension(:,:), intent(out)	C,
		real(dp), dimension(:,:), intent(out)	M,
		real(dp), dimension(:), intent(out)	Fs,
		real(dp), dimension(:), intent(out)	Fd,
		real(dp), dimension(:), intent(out)	Fi,
		real(dp), dimension(:), intent(out)	Q,
		real(dp), dimension(3,4), intent(out)	Tlg,
		real(dp), intent(in)	t,
		real(dp), intent(in)	dt,
		integer, intent(in)	istep,
		integer, intent(in)	iter,
		integer, intent(out)	ierr
	)

private

Updates a user-defined element.

Parameters

[in]	elmId	Id of the user-defined element to update
[in]	etype	User-defined element type flag
[in]	nedof	Dimension of the element matrices
[in]	triads	The triads connected to this user-defined element
[in]	engines	The engines connected to this user-defined element
	iwork	Integer work array for this user-defined element
	rwork	Real work array for this user-defined element
	hydyn	Data for hydrodynamic force calculation for this element
	envir	Environmental data
[out]	K	Tangent stiffness matrix
[out]	C	Damping matrix
[out]	M	Mass matrix
[out]	Fs	Internal elastic forces
[out]	Fd	Damping forces
[out]	Fi	Intertia forces
[out]	Q	External forces
[out]	Tlg	Local-to-global transformation matrix for the element
[in]	t	Current simulation time
[in]	dt	Time increment size
[in]	istep	Time increment counter
[in]	iter	Iteration counter
[out]	ierr	Error flag

This is the main work-horse for the user-defined element objects. It is responsible for calculation of all tangent matrices and associated right-hand-side force vectors eminating from the linearized dynamic equilibrium equation. The subroutine is typically invoked once per Newton iteration for each element.

Author: Knut Morten Okstad

Date: 28 Mar 2014

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateudes()

subroutine userdefelroutinesmodule::updateudes	(	type(userdefeltype), dimension(:), intent(inout)	elms,
		type(environmenttype), intent(inout)	env,
		real(dp), intent(in)	time,
		real(dp), intent(in)	timeStep,
		integer, intent(in)	istep,
		integer, intent(in)	iter,
		integer, intent(inout)	ierr
	)

Updates all user-defined elements in the model.

Parameters

	elms	Array of all user-defined elements in the model
	env	Environmental data
[in]	time	Current simulation time
[in]	timeStep	Time increment size
[in]	istep	Time increment counter
[in]	iter	Iteration counter
[out]	ierr	Error flag

Author: Knut Morten Okstad

Date: 28 Mar 2014

Here is the call graph for this function:

Here is the caller graph for this function:

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation

◆ addinstaticudeforces()

◆ addinudeforces()

◆ addinudemat()

◆ buildudenewtonmat()

◆ calcbuoyancyforces()

◆ calcmorisonforces()

◆ initializeude()

◆ updateude()

◆ updateudes()