type_face_field Module Reference

Declaration of a type (and associated routines) for double precision variable defined on faces. More...

Data Types
interface	assign_face_field
interface	initialize
type	t_face_field
type	t_face_field_extended
type	t_integer_face_field
type	t_logical_face_field
interface	unalloc

Functions/Subroutines
pure subroutine	assign_face_field_to_face_field (face_field_a, face_field_b)
	Copy the values of a face field in an other: b <- a.
pure subroutine	assign_scalar_to_face_field (a, face_field_b)
	Copy the values of a scalar to a face field: b <- a.
pure subroutine	initialize_face_field_double (field, kkk, lll, mmm, val_x, val_y, val_z)
	Initialize a double face field.
pure subroutine, public	initialize_face_field_extended_double (field, kkk, lll, mmm, nnn, val_x, val_y, val_z)
	Initialize a double face field extended.
pure subroutine	initialize_face_field_integer (field, kkk, lll, mmm, val_x, val_y, val_z)
	Initialize an integer face field.
pure subroutine	initialize_face_field_logical (field, kkk, lll, mmm, val_x, val_y, val_z)
	Initialize a logical face field.
subroutine	unalloc_face_field_double (vector)
	Unalloc a double face field.
subroutine	unalloc_face_field_extended_double (vector)
	Unalloc a double face field.
subroutine	unalloc_face_field_integer (vector)
	Unalloc an integer face field.
subroutine	unalloc_face_field_logical (vector)
	Unalloc a logical face field.

Detailed Description

Declaration of a type (and associated routines) for double precision variable defined on faces.

Todo

finish doc

Contains initialization and unallocation routines for integer, double precision and logical face_field type

Usage

Initialize to 0 a face field:

call initialize(face_field_variable, nx, ny, nz)

To initialize a face field to another value:

call initialize(face_field_variable, nx, ny, nz, val_x=1d0, val_y=1d0, val_z=1d0)

Release the memory:

call unalloc(face_field_variable)

Function/Subroutine Documentation

assign_face_field_to_face_field()

pure subroutine type_face_field::assign_face_field_to_face_field ( type(t_face_field), intent(in) face_field_a, type(t_face_field), intent(inout) face_field_b )

private

Copy the values of a face field in an other: b <- a.

Parameters

[in]	face_field_a	the input face_field
[in,out]	face_field_b	the output face_field

assign_scalar_to_face_field()

pure subroutine type_face_field::assign_scalar_to_face_field ( double precision, intent(in) a, type(t_face_field), intent(inout) face_field_b )

private

Copy the values of a scalar to a face field: b <- a.

Parameters

[in]	a	the input scalar
[in,out]	face_field_b	the output face_field

initialize_face_field_double()

pure subroutine type_face_field::initialize_face_field_double ( type(t_face_field), intent(inout) field, integer, intent(in) kkk, integer, intent(in) lll, integer, intent(in) mmm, double precision, intent(in), optional val_x, double precision, intent(in), optional val_y, double precision, intent(in), optional val_z )

private

Initialize a double face field.

initialize_face_field_extended_double()

pure subroutine, public type_face_field::initialize_face_field_extended_double	(	type(t_face_field_extended), intent(inout)	field,
		integer, intent(in)	kkk,
		integer, intent(in)	lll,
		integer, intent(in)	mmm,
		integer, intent(in)	nnn,
		double precision, intent(in), optional	val_x,
		double precision, intent(in), optional	val_y,
		double precision, intent(in), optional	val_z )

Initialize a double face field extended.

initialize_face_field_integer()

pure subroutine type_face_field::initialize_face_field_integer ( type(t_integer_face_field), intent(inout) field, integer, intent(in) kkk, integer, intent(in) lll, integer, intent(in) mmm, integer, intent(in), optional val_x, integer, intent(in), optional val_y, integer, intent(in), optional val_z )

private

Initialize an integer face field.

initialize_face_field_logical()

pure subroutine type_face_field::initialize_face_field_logical ( type(t_logical_face_field), intent(inout) field, integer, intent(in) kkk, integer, intent(in) lll, integer, intent(in) mmm, logical, intent(in), optional val_x, logical, intent(in), optional val_y, logical, intent(in), optional val_z )

private

Initialize a logical face field.

unalloc_face_field_double()

subroutine type_face_field::unalloc_face_field_double ( type(t_face_field), intent(inout) vector )

private

Unalloc a double face field.

unalloc_face_field_extended_double()

subroutine type_face_field::unalloc_face_field_extended_double ( type(t_face_field_extended), intent(inout) vector )

private

Unalloc a double face field.

unalloc_face_field_integer()

subroutine type_face_field::unalloc_face_field_integer ( type(t_integer_face_field), intent(inout) vector )

private

Unalloc an integer face field.

unalloc_face_field_logical()

subroutine type_face_field::unalloc_face_field_logical ( type(t_logical_face_field), intent(inout) vector )

private

Unalloc a logical face field.