IGMBaseLib 1.0
Data Types | Functions/Subroutines

Field_IcGrid2D_Manager Module Reference

This module provides the derived type which manages the data of a physical field on a icosahedral grid and some subroutines to manupulate and analize the field data. More...

Data Types

type  Field_IcGrid2D
 The derived type which manages the data of a physical field on a icosahedral grid distributed horizontally. More...
interface  Field_IcGrid2D_Init

Functions/Subroutines

subroutine init_Field_IcGrid2D0 (self, icgrid, name, field_rank, long_name, units)
 Initialize a variable of derived type Field_IcGrid2D.
subroutine init_Field_IcGrid2D1 (self, icgrid, name, rank, long_name, units)
 Initialize a variable of derived type Field_IcGrid2D.
subroutine init_Field_IcGrid2D2 (self, icgrid, name, rank)
 Initialize a variable of derived type Field_IcGrid2D.
subroutine, public Field_IcGrid2D_Final (self)
 Finalizes a variable of derived type Field_IcGrid2D.
type(Physical_Field), pointer,
public 		get_Physical_Field (self)
 Gets the pointer to a variable of derived type Physical_Field which is a base derived type of Field_IcGrid2D.
type(IcGrid2D_FVM), pointer, public get_icgrid (self)
 Get the pointer to the variable of derived type IcGrid2D_FVM which is a component of derived type Field_IcGrid2D.
subroutine, public paste_field_margin (self)
 全矩形領域の物理場データを保持する配列に対して, 袖領域を隣り合う矩形領域の境界近傍の物理データで埋める処理を行う.
real(DP), public global_mean (self)
 Calculate the global spatial average of a physical field on icosahedral grid.
character(STRING), public get_long_field2D_name (self)
 Get the long name of (or explanation for) the physcial field.
subroutine, public set_long_field2D_name (self, long_name)
 Set the long name of (or explanation for) the physcial field.
character(TOKEN), public get_field2D_units (self)
 Get the unit of the physical field.
subroutine, public set_field2D_units (self, units)
 Sets the unit of the physical field.
integer, public get_field2D_rank (self)
 Get The rank of the physical field.
character(TOKEN), public get_field2D_name (self)
 Get the (short) name of the physical field.
subroutine, public set_field2D_name (self, name)
 Sets the (short) name of the physical field.

Detailed Description

This module provides the derived type which manages the data of a physical field on a icosahedral grid and some subroutines to manupulate and analize the field data.

About Field_IcGrid2D_Manager module
  • 本モジュールでは, 正二十面格子上に水平 2 時限的に分布する物理場データを管理する構造型 Field_IcGrid2D を提供している.
  • 物理場データを保持する配列のメモリ確保は, initialize_Field_IcGrid2D によって構造型 Field_IcGrid2D の変数が初期化される際に行われる. また, その配列のメモリ解放は finalize_Field_IcGrid2D によって行われる.
  • 構造型 Field_IcGrid2D の成分である構造型 IcGrid2D_FVM のポインタ icgrid は, この物理場と関連付けられる正二十面格子データを指している.
  • 本モジュールでは, 正二十面格子上の物理場データを操作あるいは解析するためのシンプルな手続き(全球平均など)を提供している.



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

Author:
Yuta Kawai

Function/Subroutine Documentation

subroutine,public Field_IcGrid2D_Manager::Field_IcGrid2D_Final ( type(Field_IcGrid2D),intent(inout)  self)

Finalizes a variable of derived type Field_IcGrid2D.

Parameters:
[in,out]selfA variable of derived type Field_IcGrid2D.

Definition at line 307 of file Field_IcGrid2D_Manager.f90.

character(TOKEN),public Field_IcGrid2D_Manager::get_field2D_name ( type(Field_IcGrid2D),intent(in)  self)

Get the (short) name of the physical field.

Parameters:
[in]selfThe variable of derived type Field_IcGrid2D.
Returns:
The (short) name of the physical field.

Definition at line 650 of file Field_IcGrid2D_Manager.f90.

integer,public Field_IcGrid2D_Manager::get_field2D_rank ( type(Field_IcGrid2D),intent(in)  self)

Get The rank of the physical field.

Parameters:
[in]selfThe variable of derived type Field_IcGrid2D. The rank of the physical field.

Definition at line 623 of file Field_IcGrid2D_Manager.f90.

character(TOKEN),public Field_IcGrid2D_Manager::get_field2D_units ( type(Field_IcGrid2D),intent(in)  self)

Get the unit of the physical field.

Parameters:
[in]selfThe variable of derived type Field_IcGrid2D.
Returns:
The unit of the physical field.

Definition at line 571 of file Field_IcGrid2D_Manager.f90.

type(IcGrid2D_FVM),pointer,public Field_IcGrid2D_Manager::get_icgrid ( type(Field_IcGrid2D),intent(in)  self)

Get the pointer to the variable of derived type IcGrid2D_FVM which is a component of derived type Field_IcGrid2D.

Parameters:
[in,out]selfField_IcGrid2D A variable of derived type Field_IcGrid2D.
Returns:
IcGrid2D_FVM The pointer to a variable of derived type IcGrid2D_FVM.

Definition at line 366 of file Field_IcGrid2D_Manager.f90.

character(STRING),public Field_IcGrid2D_Manager::get_long_field2D_name ( type(Field_IcGrid2D),intent(in)  self)

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

Parameters:
[in]selfThe variable of derived type Field_IcGrid2D.
Returns:
The long name of (or explanation for) the physical field.

Definition at line 518 of file Field_IcGrid2D_Manager.f90.

type(Physical_Field),pointer,public Field_IcGrid2D_Manager::get_Physical_Field ( type(Field_IcGrid2D),intent(inout),target  self)

Gets the pointer to a variable of derived type Physical_Field which is a base derived type of Field_IcGrid2D.

Parameters:
[in,out]selfA variable of derived type Field_IcGrid2D.
Returns:
The pointer to a variable of base derived type Physical_Field.

Definition at line 338 of file Field_IcGrid2D_Manager.f90.

real(DP),public Field_IcGrid2D_Manager::global_mean ( type(Field_IcGrid2D),intent(inout)  self)

Calculate the global spatial average of a physical field on icosahedral grid.

Parameters:
[in,out]selfA variable of derived type Field_IcGrid2D.
Returns:
The global spatial average of a physical field.

Definition at line 450 of file Field_IcGrid2D_Manager.f90.

subroutine Field_IcGrid2D_Manager::init_Field_IcGrid2D0 ( type(Field_IcGrid2D),intent(inout)  self,
type(IcGrid2D_FVM),pointer  icgrid,
character(*),intent(in)  name,
integer,intent(in)  field_rank,
character(*),intent(in)  long_name,
character(*),intent(in)  units 
) [private]

Initialize a variable of derived type Field_IcGrid2D.

Parameters:
[in,out]selfThe variable of derived type Field_IcGrid2D.
[in]icgridThe variable of derived type IcGrid2D_FVM.
[in]nameThe (short) name of the physical field.
[in]field_rankThe rank of the physical filed.
[in]long_nameThe long name of (or the explanation for) the physical field.
[in]unitsThe unit of the physical field.

Definition at line 168 of file Field_IcGrid2D_Manager.f90.

subroutine Field_IcGrid2D_Manager::init_Field_IcGrid2D1 ( type(Field_IcGrid2D),intent(inout)  self,
type(IcGrid2D_FVM),intent(in),target  icgrid,
character(*),intent(in)  name,
integer,intent(in)  rank,
character(*),intent(in)  long_name,
character(*),intent(in)  units 
) [private]

Initialize a variable of derived type Field_IcGrid2D.

Parameters:
[in,out]selfThe variable of derived type Field_IcGrid2D.
[in]icgridThe variable of derived type IcGrid2D_FVM.
[in]nameThe (short) name of the physical field.
[in]field_rankThe rank of the physical filed.
[in]long_nameThe long name of (or the explanation for) the physical field.
[in]unitsThe unit of the physical field.

Definition at line 225 of file Field_IcGrid2D_Manager.f90.

subroutine Field_IcGrid2D_Manager::init_Field_IcGrid2D2 ( type(Field_IcGrid2D),intent(inout)  self,
type(IcGrid2D_FVM),intent(in),target  icgrid,
character(*),intent(in)  name,
integer,intent(in)  rank 
) [private]

Initialize a variable of derived type Field_IcGrid2D.

Parameters:
[in,out]selfThe variable of derived type Field_IcGrid2D.
[in]icgridThe variable of derived type IcGrid2D_FVM.
[in]nameThe (short) name of the physical field.
[in]field_rankThe rank of the physical filed.

Definition at line 273 of file Field_IcGrid2D_Manager.f90.

subroutine,public Field_IcGrid2D_Manager::paste_field_margin ( type(Field_IcGrid2D),intent(inout)  self)

全矩形領域の物理場データを保持する配列に対して, 袖領域を隣り合う矩形領域の境界近傍の物理データで埋める処理を行う.

Parameters:
[in,out]selfField_IcGrid2D A variable of derived type Field_IcGrid2D.

Definition at line 393 of file Field_IcGrid2D_Manager.f90.

subroutine,public Field_IcGrid2D_Manager::set_field2D_name ( type(Field_IcGrid2D),intent(inout)  self,
character(*),intent(in)  name 
)

Sets the (short) name of the physical field.

Parameters:
[in,out]selfThe variable of derived type Field_IcGrid2D.
[in]nameThe (short) name of the physical field.

Definition at line 679 of file Field_IcGrid2D_Manager.f90.

subroutine,public Field_IcGrid2D_Manager::set_field2D_units ( type(Field_IcGrid2D),intent(inout)  self,
character(*),intent(in)  units 
)

Sets the unit of the physical field.

Parameters:
[in,out]selfThe variable of derived type Field_IcGrid2D.
[in]unitsThe unit of the physical field.

Definition at line 597 of file Field_IcGrid2D_Manager.f90.

subroutine,public Field_IcGrid2D_Manager::set_long_field2D_name ( type(Field_IcGrid2D),intent(inout)  self,
character(*),intent(in)  long_name 
)

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

Parameters:
[in,out]selfThe variable of derived type Field_IcGrid2D.
[in]long_nameThe long name of (or explanation for) the physical field.

Definition at line 545 of file Field_IcGrid2D_Manager.f90.

 All Classes Namespaces Files Functions Variables
Generated on Thu Sep 22 2011 20:05:10 for IGMBaseLib by  doxygen 1.7.3