Initialize the OASIS coupler infrastructure. More...

Data Types
type	prism_coupler_type
	Coupler data for managing all aspects of coupling in OASIS. More...

type	prism_router_type
	Router information for rearranging data on tasks. More...

Public Member Functions
subroutine, public	oasis_coupler_setup ()
	Main routine to setup couplers. More...

Public Attributes
integer(kind=ip_i4_p), parameter, public	prism_coupler_avsmax =5
	maximum number of higher order terms in mapping More...

type(prism_router_type), dimension(:), pointer, public	prism_router
	prism_router array More...

integer(kind=ip_i4_p), public	prism_mcoupler
	max couplers More...

type(prism_coupler_type), dimension(:), pointer, public	prism_coupler_put
	prism_coupler put array More...

type(prism_coupler_type), dimension(:), pointer, public	prism_coupler_get
	prism_coupler get array More...

integer(kind=ip_i4_p), public	lcouplerid
	last coupler id More...

integer(kind=ip_i4_p), public	lcouplertime
	last coupler time More...

integer(kind=ip_i4_p), public	lastseq
	last coupler sequence More...

integer(kind=ip_i4_p), public	lastseqtime
	last coupler sequence time More...

Private Member Functions
subroutine	oasis_coupler_print (cplid, pcprint)
	Print routine for oasis_couplers. More...

subroutine	cplsort (num, fld, sortkey)
	Sort a character array using a sort key. More...

subroutine	cplsortkey (num, arr, sortkey)
	Sort an integer array using a sort key. More...

subroutine	cplfind (num, fldlist, fld, ifind, nfind)
	Search a character field list for a matching values. More...

subroutine	merge (A, X, NA, B, Y, NB, C, Z, NC)
	Merge routine needed for mergesort. More...

recursive subroutine	mergesort (N, A, T, S, Z)
	Generic mergesort routine. More...

Private Attributes
integer(kind=ip_i4_p)	prism_mrouter
	max routers More...

integer(kind=ip_i4_p)	prism_nrouter = 0
	router counter More...

Detailed Description

Initialize the OASIS coupler infrastructure.

Definition at line 4 of file mod_oasis_coupler.F90.

Member Function/Subroutine Documentation

subroutine mod_oasis_coupler::cplfind	(	integer(in), intent(in)	num,
		character(len=cl), dimension(:), intent(in)	fldlist,
		character(len=cl), intent(in)	fld,
		integer(in), intent(out)	ifind,
		integer(in), intent(out)	nfind
	)

private

Search a character field list for a matching values.

Parameters

[in]	num	size of array
[in]	fldlist	sorted field list
[in]	fld	field to search for
[out]	ifind	first match index
[out]	nfind	number that match

Definition at line 1860 of file mod_oasis_coupler.F90.

subroutine mod_oasis_coupler::cplsort	(	integer(in), intent(in)	num,
		character(len=cl), dimension(:), intent(inout)	fld,
		integer(in), dimension(:), intent(inout)	sortkey
	)

private

Sort a character array using a sort key.

Parameters

[in]	num	size of array
[in,out]	fld	sort field
[in,out]	sortkey	sortkey

Definition at line 1751 of file mod_oasis_coupler.F90.

subroutine mod_oasis_coupler::cplsortkey	(	integer(in), intent(in)	num,
		integer(in), dimension(:), intent(inout)	arr,
		integer(in), dimension(:), intent(in)	sortkey
	)

private

Sort an integer array using a sort key.

Parameters

[in]	num	size of array
[in,out]	arr	field to sort
[in]	sortkey	sortkey

Definition at line 1803 of file mod_oasis_coupler.F90.

subroutine mod_oasis_coupler::merge	(	character(cl), dimension(na), intent(inout)	A,
		integer(in), dimension(na), intent(inout)	X,
		integer, intent(in)	NA,
		character(cl), dimension(nb), intent(in)	B,
		integer(in), dimension(nb), intent(in)	Y,
		integer, intent(in)	NB,
		character(cl), dimension(nc), intent(inout)	C,
		integer(in), dimension(nc), intent(inout)	Z,
		integer, intent(in)	NC
	)

private

Merge routine needed for mergesort.

Definition at line 1955 of file mod_oasis_coupler.F90.

recursive subroutine mod_oasis_coupler::mergesort	(	integer, intent(in)	N,
		character(cl), dimension(n), intent(inout)	A,
		character(cl), dimension((n+1)/2), intent(out)	T,
		integer(in), dimension(n), intent(inout)	S,
		integer(in), dimension((n+1)/2), intent(out)	Z
	)

private

Generic mergesort routine.

Definition at line 2002 of file mod_oasis_coupler.F90.

subroutine mod_oasis_coupler::oasis_coupler_print	(	integer(ip_i4_p), intent(in)	cplid,
		type(prism_coupler_type), intent(in)	pcprint
	)

private

Print routine for oasis_couplers.

Parameters

[in]	cplid	coupler id
[in]	pcprint	specific prism_coupler

Definition at line 1651 of file mod_oasis_coupler.F90.

subroutine, public mod_oasis_coupler::oasis_coupler_setup ( )

Main routine to setup couplers.

This routine initializes all the coupler data based on the namcouple inputs and the calls into the OASIS initialization interfaces from models. It reconciles everything. This is called from oasis_enddef.

Allocate and zero prism_router, prism_mapper, prism_coupler based on nnamcpl
Generate model variable lists across all models based on def_var calls. These will be reconciled with the namcouple input. These are sorted to improve search performance later.
Setup couplers based on namcouple and model variable info.
Preprocess namcouple strings and sort for faster searches
Loop over all my model variables
- Get parition and field information
- Check if variable is In or Out and then find namcouple matches
- Loop over the namcouple matches
  - Migrate namcouple info into part
  - Make sure it's either an In or Out, sanity check
  - Determine matching field name from namcouple
  - Search for list of models with other variable
  - Loop over those other matching variable names
    - Check that one side is In and other side is Out for communication
    - Check if input or output, field name should match on both sides.
    - Generate field list, multiple field support
    - Add this coupler to list of prism_var couplers
    - Copy namcouple settings into this coupler or check that coupler is consistent with prior setting
    - Set prism_coupler input and output flags
    - Setup prism_coupler router
    - Setup prism_coupler mapper
    - Try to reuse mapper already defined, must match mapping file and partition
    - Or get ready to initialize a new mapper
Initialize coupling infrastructure based on initial coupler setup above
Loop over all couplers
- Initialize avect1 which stores the get/put data
- Compute nflds for this coupling and initialize avcnt and status
- Initialize the mapper data
- Read mapper mask and area if not already done
- Initialize avect1m, the data in avect1 mapped to another grid
- Initialize router based on rpartID
Diagnostics for all couplers

Definition at line 118 of file mod_oasis_coupler.F90.

Member Data Documentation

integer(kind=ip_i4_p), public mod_oasis_coupler::lastseq

last coupler sequence

Definition at line 102 of file mod_oasis_coupler.F90.

integer(kind=ip_i4_p), public mod_oasis_coupler::lastseqtime

last coupler sequence time

Definition at line 103 of file mod_oasis_coupler.F90.

integer(kind=ip_i4_p), public mod_oasis_coupler::lcouplerid

last coupler id

Definition at line 100 of file mod_oasis_coupler.F90.

integer(kind=ip_i4_p), public mod_oasis_coupler::lcouplertime

last coupler time

Definition at line 101 of file mod_oasis_coupler.F90.

integer(kind=ip_i4_p), parameter, public mod_oasis_coupler::prism_coupler_avsmax =5

maximum number of higher order terms in mapping

Definition at line 42 of file mod_oasis_coupler.F90.

type(prism_coupler_type), dimension(:), pointer, public mod_oasis_coupler::prism_coupler_get

prism_coupler get array

Definition at line 98 of file mod_oasis_coupler.F90.

type(prism_coupler_type), dimension(:), pointer, public mod_oasis_coupler::prism_coupler_put

prism_coupler put array

Definition at line 97 of file mod_oasis_coupler.F90.

integer(kind=ip_i4_p), public mod_oasis_coupler::prism_mcoupler

max couplers

Definition at line 96 of file mod_oasis_coupler.F90.

integer(kind=ip_i4_p) mod_oasis_coupler::prism_mrouter

private

max routers

Definition at line 92 of file mod_oasis_coupler.F90.

integer(kind=ip_i4_p) mod_oasis_coupler::prism_nrouter = 0

private

router counter

Definition at line 93 of file mod_oasis_coupler.F90.

type(prism_router_type), dimension(:), pointer, public mod_oasis_coupler::prism_router

prism_router array

Definition at line 94 of file mod_oasis_coupler.F90.

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

/Users/tcraig/Desktop/oasis/oasis3-mct.trunk/lib/psmile/src/mod_oasis_coupler.F90

Data Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

Member Data Documentation