IGMBaseLib 1.0
Functions/Subroutines

Field_Pattern_Builder Module Reference

This module provides some subroutines to create a typical physical field, such as solid body rotation. More...

Functions/Subroutines

subroutine, public create_solid_rotation_field (field, angular_speed, alpha)
 Generates the solid body rotation, and store the physical field data into the specified variable of derived type Field_IcGrid2D.
subroutine, public create_planetaryVorticity_field (field, angular_speed, alpha)
 Generates the planetary vorticity, and store the physical field data into the specified variable of derived type Field_IcGrid2D.
subroutine, public create_cosine_bell_field (field, lambda_c, theta_c, cbR, h0)
 Generates the cosine bell field, and store the physical field data into the specified variable of derived type Field_IcGrid2D.

Detailed Description

This module provides some subroutines to create a typical physical field, such as solid body rotation.

About Field_Pattern_Builder module
  • By the subroutines in this module, one can create the physical fields commonly used for numerical simulation in geophysical fluid dynamics, such as solid body rotation, planetary vorticity or cosin bell field.
  • The created physical field data will be stored in derived type Field_IcGrid2D which manages a physical field on icosahedral grid.
Since:
IGMBaseLib 1.0



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

Author:
Yuta Kawai

Function/Subroutine Documentation

subroutine,public Field_Pattern_Builder::create_cosine_bell_field ( type(Field_IcGrid2D),intent(inout)  field,
real(DP),intent(in)  lambda_c,
real(DP),intent(in)  theta_c,
real(DP),intent(in)  cbR,
real(DP),intent(in)  h0 
)

Generates the cosine bell field, and store the physical field data into the specified variable of derived type Field_IcGrid2D.

Parameters:
[in,out]fieldThe variable of derived type Field_IcGrid2D in which the created physical data will be stored.
[in]lambda_cThe longitude at which the center of the cosine bell is located.
[in]theta_cThe latitude at which the center of the cosine bell is located.
[in]cbRThe radius of cosine bell.
[in]h0The maximum height of the cosine bell.

Definition at line 213 of file Field_Pattern_Builder.f90.

subroutine,public Field_Pattern_Builder::create_planetaryVorticity_field ( type(Field_IcGrid2D),intent(inout)  field,
real(DP),intent(in)  angular_speed,
real(DP),intent(in)  alpha 
)

Generates the planetary vorticity, and store the physical field data into the specified variable of derived type Field_IcGrid2D.

Parameters:
[in,out]fieldThe variable of derived type Field_IcGrid2D in which the created physical data will be stored.
[in]angular_speedThe angular velocity [rad/s].
[in]alphaThe angle between z axis of the cartesian coordinate system and the axis of rotation lying in the x-z plane [rad].

Definition at line 152 of file Field_Pattern_Builder.f90.

subroutine,public Field_Pattern_Builder::create_solid_rotation_field ( type(Field_IcGrid2D),intent(inout)  field,
real(DP),intent(in)  angular_speed,
real(DP),intent(in)  alpha 
)

Generates the solid body rotation, and store the physical field data into the specified variable of derived type Field_IcGrid2D.

Parameters:
[in,out]fieldThe variable of derived type Field_IcGrid2D in which the created physical data will be stored.
[in]angular_speedAngular speed [rad/s].
[in]alphaThe angle between z axis of the cartesian coordinate system and the axis of rotation lying in the x-z plane [rad].

Definition at line 100 of file Field_Pattern_Builder.f90.

 All Classes Namespaces Files Functions Variables