couple_mod Module Reference

Data Types
type	couple_data_type

Functions/Subroutines
subroutine, public	init_couple ()
subroutine, public	add_sender (MESH_SEND, CID)
subroutine	read_recv (FILE_RECV, RECV_VAR, CID, NPOIN, SEND_NODE, NPP)
subroutine, public	add_receiver (MESH_RECV, FILE_RECV, RECV_VAR, CID)
subroutine, public	send_couple (CID, NPOIN, NVAR, VARCOUPLE)
subroutine, public	receive_couple (CID, NPOIN, NVAR, VARCOUPLE, DEFAULT_VAL)
subroutine, public	end_couple
subroutine	debug_info (DEBUG_STRING, DEBUG_INT)

Variables
type(couple_data_type), dimension(:), allocatable	cpld
integer	nrcouple
integer, parameter	maxcouple = 4
integer, parameter	maxvar = 10
integer, parameter	maxnpp = 20
logical, public	do_couple = .FALSE.

Function/Subroutine Documentation

add_receiver()

subroutine, public couple_mod::add_receiver	(	type(bief_mesh), intent(in)	MESH_RECV,
		type(bief_file), intent(in)	FILE_RECV,
		character(len=16), intent(in)	RECV_VAR,
		integer, intent(in)	CID
	)

Parameters

[in]	cid	MESH_RECV Mesh (local) of the receiver
[in]	FILE_RECV	File with information from where to receive data
[in]	RECV_VAR	Name of variable which contains the node nr of the sender
[in]	CID	Id of the coupling (starts at 1)

Definition at line 381 of file couple_mod.F.

Here is the call graph for this function:

Here is the caller graph for this function:

add_sender()

subroutine, public couple_mod::add_sender	(	type (bief_mesh), intent(in)	MESH_SEND,
		integer, intent(in)	CID
	)

Parameters

[in]	cid	CID Id of the coupling (starts at 1)
[in]	MESH_SEND	Mesh (local) of the sender

Definition at line 129 of file couple_mod.F.

Here is the call graph for this function:

Here is the caller graph for this function:

debug_info()

subroutine couple_mod::debug_info ( character (len=*), intent(in)  DEBUG_STRING, integer, intent(in), optional  DEBUG_INT  )

private

Parameters

[in]	debug_string	DEBUG_STRING MESH (LOCAL) OF THE RECEIVER
[in]	DEBUG_INT	FILE_RECV FILE WITH INFORMATION FROM WHERE TO RECEIVE DATA

Definition at line 1001 of file couple_mod.F.

Here is the caller graph for this function:

end_couple()

subroutine, public couple_mod::end_couple

(

)

Brief:

DEALLOCATE VARIABLE NEEDED FOR COUPLING

Definition at line 958 of file couple_mod.F.

init_couple()

subroutine, public couple_mod::init_couple

(

)

Brief:

CONSTRUCTOR FOR COUPLING ROUTINE

Definition at line 94 of file couple_mod.F.

Here is the caller graph for this function:

read_recv()

subroutine couple_mod::read_recv ( type(bief_file), intent(in)  FILE_RECV, character(len=16), intent(in)  RECV_VAR, integer, intent(in)  CID, integer, intent(in)  NPOIN, double precision, dimension(:,:), intent(out), allocatable  SEND_NODE, integer, intent(inout)  NPP  )

private

Parameters

[in]	cid	FILE_RECV FILE WITH INFORMATION FROM WHERE TO RECEIVE DATA
[in]	RECV_VAR	NAME OF VARIABLE WHICH CONTAINS THE NODE NR OF THE SENDER
[in]	CID	ID OF THE COUPLING (STARTS AT 1)
[in]	NPOIN	NUMBER OF 2D MESH POINTS
[in]	SEND_NODE	ARRAY OF NODES SEND
[in]	NPP	MAXIMUM NUMBER OF NODES USED IN DETERMINATION OF A NODE
[in]	npoin	FILE_RECV FILE WITH INFORMATION FROM WHERE TO RECEIVE DATA
[in]	RECV_VAR	NAME OF VARIABLE WHICH CONTAINS THE NODE NR OF THE SENDER
[in]	CID	ID OF THE COUPLING (STARTS AT 1)
[in]	NPOIN	NUMBER OF 2D MESH POINTS
[in]	SEND_NODE	ARRAY OF NODES SEND
[in]	NPP	MAXIMUM NUMBER OF NODES USED IN DETERMINATION OF A NODE

Definition at line 233 of file couple_mod.F.

Here is the call graph for this function:

Here is the caller graph for this function:

receive_couple()

subroutine, public couple_mod::receive_couple	(	integer, intent(in)	CID,
		integer, intent(in)	NPOIN,
		integer, intent(in)	NVAR,
		type (bief_obj), intent(inout)	VARCOUPLE,
		double precision, dimension(nvar), intent(in), optional	DEFAULT_VAL
	)

Parameters

[in]	npoin	NPOIN NUMBER OF POINTS
[in]	NVAR	NUMBER OF VARIABLES
[in]	CID	COUPLE ID

Definition at line 838 of file couple_mod.F.

Here is the call graph for this function:

Here is the caller graph for this function:

send_couple()

subroutine, public couple_mod::send_couple	(	integer, intent(in)	CID,
		integer, intent(in)	NPOIN,
		integer, intent(in)	NVAR,
		type(bief_obj), intent(in)	VARCOUPLE
	)

Parameters

[in]	npoin	NPOIN NUMBER OF POINTS
[in]	NVAR	NUMBER OF VARIABLES
[in]	CID	COUPLE ID
[in]	VARCOUPLE	STRUCTURE WITH VARIABLES TO BE SEND
[in]	nvar	NPOIN NUMBER OF POINTS
[in]	NVAR	NUMBER OF VARIABLES
[in]	CID	COUPLE ID
[in]	VARCOUPLE	STRUCTURE WITH VARIABLES TO BE SEND
[in]	cid	NPOIN NUMBER OF POINTS
[in]	NVAR	NUMBER OF VARIABLES
[in]	CID	COUPLE ID
[in]	VARCOUPLE	STRUCTURE WITH VARIABLES TO BE SEND

Definition at line 705 of file couple_mod.F.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

cpld

type (couple_data_type), dimension(:), allocatable couple_mod::cpld

Definition at line 71 of file couple_mod.F.

do_couple

logical, public couple_mod::do_couple = .FALSE.

Definition at line 80 of file couple_mod.F.

maxcouple

integer, parameter couple_mod::maxcouple = 4

Definition at line 74 of file couple_mod.F.

maxnpp

integer, parameter couple_mod::maxnpp = 20

Definition at line 78 of file couple_mod.F.

maxvar

integer, parameter couple_mod::maxvar = 10

Definition at line 76 of file couple_mod.F.

nrcouple

integer couple_mod::nrcouple

Definition at line 72 of file couple_mod.F.