agrif_bcfunction Module Reference

Module Agrif_BcFunction. More...

Data Types
interface	agrif_save_forrestore
interface	agrif_set_parent

Functions/Subroutines
subroutine	agrif_set_parent_int (integer_variable, value)
	This subroutine is used to set the type of the variable of the parent grid of the current grid as integer variable. More...
subroutine	agrif_set_parent_real4 (real_variable, value)
	This subroutine is used to set a real variable of the parent grid of the current grid as Single-precision real floating-point value. More...
subroutine	agrif_set_parent_real8 (real_variable, value)
	This subroutine is used to set a real variable of the parent grid of the current grid as Double-precision real floating-point value. More...
subroutine	agrif_set_restore (tabvarsindic)
	This subroutine is used to set the index of the current grid variable we want to restore. More...
subroutine	agrif_save_forrestore0d (tabvarsindic0, tabvarsindic)
subroutine	agrif_save_forrestore2d (q, tabvarsindic)
	This function is used to restore a current grid variable (with the index tabvarsindic) to the input 2D-variable. More...
subroutine	agrif_save_forrestore3d (q, tabvarsindic)
	This function is used to restore a current grid variable (with the index tabvarsindic) to the input 3D-variable. More...
subroutine	agrif_save_forrestore4d (q, tabvarsindic)
	This function is used to restore a current grid variable (with the index tabvarsindic) to the input 4D-variable. More...

Detailed Description

Module Agrif_BcFunction.

Function/Subroutine Documentation

subroutine agrif_bcfunction::agrif_set_parent_int	(	integer, intent(in)	integer_variable,
		integer, intent(in)	value
	)

This subroutine is used to set the type of the variable of the parent grid of the current grid as integer variable.

Parameters

[in]	integer_variable	indice of the variable in tabvars
[in]	value	input value

subroutine agrif_bcfunction::agrif_set_parent_real4	(	real(kind=4), intent(in)	real_variable,
		real(kind=4), intent(in)	value
	)

This subroutine is used to set a real variable of the parent grid of the current grid as Single-precision real floating-point value.

Parameters

[in]	real_variable	input variable
[in]	value	input value for the parent grid

subroutine agrif_bcfunction::agrif_set_parent_real8	(	real(kind=8), intent(in)	real_variable,
		real(kind=8), intent(in)	value
	)

This subroutine is used to set a real variable of the parent grid of the current grid as Double-precision real floating-point value.

Parameters

[in]	real_variable	input variable
[in]	value	input value for the parent grid

subroutine agrif_bcfunction::agrif_set_restore

(

integer, intent(in)

tabvarsindic

)

This subroutine is used to set the index of the current grid variable we want to restore.

Parameters

[in]

tabvarsindic

indice of the variable in tabvars

subroutine agrif_bcfunction::agrif_save_forrestore0d	(	integer, intent(in)	tabvarsindic0,
		integer, intent(in)	tabvarsindic
	)

Parameters

[in]	tabvarsindic0	index of the current grid variable
[in]	tabvarsindic	index of the varible which should be restored

subroutine agrif_bcfunction::agrif_save_forrestore2d	(	real, dimension(:,:), intent(in)	q,
		integer, intent(in)	tabvarsindic
	)

This function is used to restore a current grid variable (with the index tabvarsindic) to the input 2D-variable.

Parameters

[in]	q	input 2D-variable which should be saved
[in]	tabvarsindic	index of the current grid variable we want to restore

subroutine agrif_bcfunction::agrif_save_forrestore3d	(	real, dimension(:,:,:), intent(in)	q,
		integer, intent(in)	tabvarsindic
	)

This function is used to restore a current grid variable (with the index tabvarsindic) to the input 3D-variable.

Parameters

[in]	q	input 3D-variable which should be saved
[in]	tabvarsindic	index of the current grid variable we want to restore

subroutine agrif_bcfunction::agrif_save_forrestore4d	(	real, dimension(:,:,:,:), intent(in)	q,
		integer, intent(in)	tabvarsindic
	)

This function is used to restore a current grid variable (with the index tabvarsindic) to the input 4D-variable.

Parameters

[in]	q	input 4D-variable which should be saved
[in]	tabvarsindic	index of the current grid variable we want to restore