INTERFACE / PUBLIC ENTITIES / NAMELIST / FILES / REFERENCES / ERRORS / BUGS / PLANS / PRIVATES

MODULE xxxxxxx

Contact: Jeff Anderson
Reviewers:  
Revision: $Revision: 1.3 $
Change Date: $Date: 2002/07/11 21:09:47 $
Change history: see CVS log (cop-out, I know)

OVERVIEW

A note about documentation style. Optional arguments are enclosed in brackets [like this].

Provides a representation of a physical location on a one dimensional periodic domain. A type that abstracts the location is provided along with operators to compute the distance between two locations. This is a member of a class of similar location modules that provide the same abstraction for different represenations of physical space (for instance a three dimensional shell on a sphere).




OTHER MODULES USED

types_mod
utilities_mod
random_seq_mod



PUBLIC INTERFACE

use xxxxxxx, only : location_type &
 get_dist &
 get_location &
 set_location
 write_location
 read_location
 interactive_location

NOTES

Optional namelist interface &atmosphere_nml may be read from file input.nml.




PUBLIC ENTITIES

fill in text here




type location_type
   private
   real(r8) :: x
end type location_type

Detailed Description

Provides an abstract representation of physical location on a one dimensional periodic domain.

Component Description
x the nondimensional distance [0,1]


call write_location(file, loc)
integer,               intent(in)    ::  file 
type(location_type),   intent(inout) ::  loc 

Description

Given an integer IO channel of an open file and a location, writes the location to this file.

file the unit number of the open file.
loc location type to be written.

Notes

Eventually, a more general file descriptor type should replace the use of the integer unit number.


var = get_dist( loc1, loc2)
type(location_type),     intent(in)  ::  loc1, loc2 
real(r8)                             ::  var 

Description

Returns the distance between two locations.

loc1     first location.
loc2 second location.
var distance between loc1 and loc2.


NAMELIST

None


FILES


REFERENCES


ERROR CODES and CONDITIONS

CodeRoutineCondition
xxxx yyyyy size of [argument] is incorrect
The size of [argument] must be between 1 and 4.
xxxx yyyyy bad judgement
What were you thinking?


KNOWN BUGS

None.


FUTURE PLANS


PRIVATE Components

type location_type
   private
   real(r8) :: x
end type location_type

Discussion