Physical_Field_Manager Module Reference

This module provides the base type for some objects to manage the physical field data. More...

Data Types
type	Physical_Field
	This type is a Base type for some objects to manage the physical field data. More...
Functions/Subroutines
subroutine, public	Physical_Field_Init (self, name, field_rank, long_name, units)
	Initialize a variable of derived type Physical_Field.
character(STRING), public	get_long_field_name (self)
	Get the long name of (or explanation for) the physcial field.
subroutine, public	set_long_field_name (self, long_name)
	Set the long name of (or explanation for) the physcial field.
character(TOKEN), public	get_field_units (self)
	Get the unit of the physical field.
subroutine, public	set_field_units (self, units)
	Set the unit of the physical field.
integer, public	get_field_rank (self)
	Get the rank of the physical field.
character(TOKEN), public	get_field_name (self)
	Get the (short) name of the physical field.
subroutine, public	set_field_name (self, name)
	Set the (short) name of the physical field.

---

Detailed Description

This module provides the base type for some objects to manage the physical field data.

Copyright (C) GFD Dennou Club, 2011-2012. All rights reserved.
license ??

Author:

Yuta Kawai

---

Function/Subroutine Documentation

character(TOKEN),public Physical_Field_Manager::get_field_name

(

type(Physical_Field),intent(in)

self

)

Get the (short) name of the physical field.

Parameters:

[in]

self

The variable of derived type Physical_Field.

Returns:

The (short) name of the physical field.

Definition at line 255 of file Physical_Field_Manager.f90.

integer,public Physical_Field_Manager::get_field_rank

(

type(Physical_Field),intent(in)

self

)

Get the rank of the physical field.

Parameters:

[in]

self

The variable of derived type Physical_Field.

Returns:

val The rank of the physical field.

Definition at line 228 of file Physical_Field_Manager.f90.

character(TOKEN),public Physical_Field_Manager::get_field_units

(

type(Physical_Field),intent(in)

self

)

Get the unit of the physical field.

Parameters:

[in]

self

The variable of derived type Physical_Field. val The unit of the physical field.

Definition at line 176 of file Physical_Field_Manager.f90.

character(STRING),public Physical_Field_Manager::get_long_field_name

(

type(Physical_Field),intent(in)

self

)

Get the long name of (or explanation for) the physcial field.

Parameters:

[in]

self

The reference of Physical_Field type object.

Returns:

val The long name of (or explanation for) the physical field.

Definition at line 123 of file Physical_Field_Manager.f90.

subroutine,public Physical_Field_Manager::Physical_Field_Init	(	type(Physical_Field),intent(inout)	self,
		character(*),intent(in)	name,
		integer,intent(in)	field_rank,
		character(*),intent(in),optional	long_name,
		character(*),intent(in),optional	units
	)

Initialize a variable of derived type Physical_Field.

Parameters:

[in,out]	self	The variable of derived type Physical_Field.
[in]	name	The (short) name of the physical field.
[in]	field_rank	The rank of the physical filed.
[in]	long_name	The long name of (or the explanation for) the physical field.
[in]	units	The unit of the physical field.

Definition at line 89 of file Physical_Field_Manager.f90.

subroutine,public Physical_Field_Manager::set_field_name	(	type(Physical_Field),intent(inout)	self,
		character(*),intent(in)	name
	)

Set the (short) name of the physical field.

Parameters:

[in,out]	self	The variable of derived type Physical_Field.
[in]	name	The (short) name of the physical field.

Definition at line 284 of file Physical_Field_Manager.f90.

subroutine,public Physical_Field_Manager::set_field_units	(	type(Physical_Field),intent(inout)	self,
		character(*),intent(in)	units
	)

Set the unit of the physical field.

Parameters:

[in,out]	self	The variable of derived type Physical_Field.
[in]	units	The unit of the physical field.

Definition at line 202 of file Physical_Field_Manager.f90.

subroutine,public Physical_Field_Manager::set_long_field_name	(	type(Physical_Field),intent(inout)	self,
		character(*),intent(in)	long_name
	)

Set the long name of (or explanation for) the physcial field.

Parameters:

[in,out]	self	The variable of derived type Physical_Field.
[in]	long_name	The long name of (or explanation for) the physical field.

Definition at line 150 of file Physical_Field_Manager.f90.