camp_sub_model_data::sub_model_update_data_t Type Reference

Update cookie. More...

Public Member Functions
procedure	get_type (this)
	Get the sub-model type.
procedure	get_cell_id (this)
	Get the grid cell to update.
procedure	get_data (this)
	Get the update data.
procedure	pack_size (this, comm)
	Determine the number of bytes required to pack the given value.
procedure	bin_pack (this, buffer, pos, comm)
	Packs the given value into the buffer, advancing position.
procedure	bin_unpack (this, buffer, pos, comm)
	Unpacks the given value from the buffer, advancing position.
procedure(internal_pack_size), deferred	internal_pack_size internal_pack_size
	Extending type pack size (internal use only)
procedure(internal_bin_pack), deferred	internal_bin_pack internal_bin_pack
	Extending type bin pack (internal use only)
procedure(internal_bin_unpack), deferred	internal_bin_unpack internal_bin_unpack
	Extending type bin unpack (internal use only)
procedure	print (this, file_unit)
	Print the update data.

Public Attributes
integer(kind=c_int)	sub_model_type
	Sub-model type.
integer(kind=c_int)	sub_model_solver_id = 0
	Sub-model solver id.
integer(kind=c_int)	cell_id = 1
	Grid cell to update.
type(c_ptr)	update_data
	Update data.

Detailed Description

Update cookie.

Definition at line 112 of file sub_model_data.F90.

Member Function/Subroutine Documentation

bin_pack()

procedure camp_sub_model_data::sub_model_update_data_t::bin_pack	(	class(sub_model_update_data_t), intent(in)	this,
		character, dimension(:), intent(inout)	buffer,
		integer, intent(inout)	pos,
		integer, intent(in), optional	comm
	)

Packs the given value into the buffer, advancing position.

Parameters

[in]	this	Sub model update data
[in,out]	buffer	Memory buffer
[in,out]	pos	Current buffer position
[in]	comm	MPI communicator

Definition at line 131 of file sub_model_data.F90.

bin_unpack()

procedure camp_sub_model_data::sub_model_update_data_t::bin_unpack	(	class(sub_model_update_data_t), intent(out)	this,
		character, dimension(:), intent(inout)	buffer,
		integer, intent(inout)	pos,
		integer, intent(in), optional	comm
	)

Unpacks the given value from the buffer, advancing position.

Parameters

[out]	this	Sub model update data
[in,out]	buffer	Memory buffer
[in,out]	pos	Current buffer position
[in]	comm	MPI communicator

Definition at line 133 of file sub_model_data.F90.

get_cell_id()

procedure camp_sub_model_data::sub_model_update_data_t::get_cell_id

(

class(sub_model_update_data_t), intent(in)

this

)

Get the grid cell to update.

Returns

Grid cell id

Parameters

[in]

this

Update data

Definition at line 125 of file sub_model_data.F90.

get_data()

procedure camp_sub_model_data::sub_model_update_data_t::get_data

(

class(sub_model_update_data_t), intent(in)

this

)

Get the update data.

Returns

Update data ptr

Parameters

[in]

this

Update data

Definition at line 127 of file sub_model_data.F90.

get_type()

procedure camp_sub_model_data::sub_model_update_data_t::get_type

(

class(sub_model_update_data_t), intent(in)

this

)

Get the sub-model type.

Returns

Sub-model type

Parameters

[in]

this

Update data

Definition at line 123 of file sub_model_data.F90.

internal_bin_pack()

procedure(internal_bin_pack), deferred camp_sub_model_data::sub_model_update_data_t::internal_bin_pack

pure virtual

Extending type bin pack (internal use only)

Definition at line 137 of file sub_model_data.F90.

internal_bin_unpack()

procedure(internal_bin_unpack), deferred camp_sub_model_data::sub_model_update_data_t::internal_bin_unpack

pure virtual

Extending type bin unpack (internal use only)

Definition at line 139 of file sub_model_data.F90.

internal_pack_size()

procedure(internal_pack_size), deferred camp_sub_model_data::sub_model_update_data_t::internal_pack_size

pure virtual

Extending type pack size (internal use only)

Definition at line 135 of file sub_model_data.F90.

pack_size()

procedure camp_sub_model_data::sub_model_update_data_t::pack_size	(	class(sub_model_update_data_t), intent(in)	this,
		integer, intent(in), optional	comm
	)

Determine the number of bytes required to pack the given value.

Parameters

[in]	this	Sub model update data
[in]	comm	MPI communicator

Definition at line 129 of file sub_model_data.F90.

print()

procedure camp_sub_model_data::sub_model_update_data_t::print	(	class(sub_model_update_data_t), intent(in)	this,
		integer(kind=i_kind), optional	file_unit
	)

Print the update data.

Parameters

[in]	this	Sub model update data
	file_unit	File unit for output

Definition at line 141 of file sub_model_data.F90.

Member Data Documentation

cell_id

integer(kind=c_int) camp_sub_model_data::sub_model_update_data_t::cell_id = 1

Grid cell to update.

Definition at line 118 of file sub_model_data.F90.

sub_model_solver_id

integer(kind=c_int) camp_sub_model_data::sub_model_update_data_t::sub_model_solver_id = 0

Sub-model solver id.

Definition at line 116 of file sub_model_data.F90.

sub_model_type

integer(kind=c_int) camp_sub_model_data::sub_model_update_data_t::sub_model_type

Sub-model type.

Definition at line 114 of file sub_model_data.F90.

update_data

type(c_ptr) camp_sub_model_data::sub_model_update_data_t::update_data

Update data.

Definition at line 120 of file sub_model_data.F90.

---

The documentation for this type was generated from the following file:

• sub_model_data.F90