0.6.0
Loading...
Searching...
No Matches
type_face_field Module Reference

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

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_athe input face_field
[in,out]face_field_bthe 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]athe input scalar
[in,out]face_field_bthe output face_field