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

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

Functions/Subroutines

pure subroutine assign_edge_field_to_edge_field (edge_field_a, edge_field_b)
 Copy the values of a edge field in an other: b <- a.
 
pure subroutine assign_scalar_to_edge_field (a, edge_field_b)
 Copy the values of a scalar to a edge field: b <- a.
 
pure subroutine initialize_edge_field_double (field, kkk, lll, mmm, val_xy, val_xz, val_yz)
 Initialize a double edge field.
 
pure subroutine initialize_edge_field_integer (field, kkk, lll, mmm, val_xy, val_xz, val_yz)
 Initialize an integer edge field.
 
pure subroutine initialize_edge_field_logical (field, kkk, lll, mmm, val_xy, val_xz, val_yz)
 Initialize a logical edge field.
 
subroutine unalloc_edge_field_double (vector)
 Unalloc a double edge field.
 
subroutine unalloc_edge_field_integer (vector)
 Unalloc an integer edge field.
 
subroutine unalloc_edge_field_logical (vector)
 Unalloc a logical edge field.
 

Detailed Description

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

Todo
finish doc

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

Usage

Initialize to 0 a edge field:

call initialize(edge_field_variable, nx, ny, nz)

To initialize an adge field to another value:

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

Release the memory:

call unalloc(edge_field_variable)

Function/Subroutine Documentation

◆ assign_edge_field_to_edge_field()

pure subroutine type_edge_field::assign_edge_field_to_edge_field ( type(t_edge_field), intent(in) edge_field_a,
type(t_edge_field), intent(inout) edge_field_b )
private

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

Parameters
[in]edge_field_athe input edge_field
[in,out]edge_field_bthe output edge_field

◆ assign_scalar_to_edge_field()

pure subroutine type_edge_field::assign_scalar_to_edge_field ( double precision, intent(in) a,
type(t_edge_field), intent(inout) edge_field_b )
private

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

Parameters
[in]athe input scalar
[in,out]edge_field_bthe output edge_field