yac.Field Class Reference

Stored the field_id. More...

Collaboration diagram for yac.Field:

Public Member Functions
	__init__ (self, field_id, size=None)
	create (cls, str field_name, Component comp, points, collection_size, str timestep, TimeUnit timeunit, masks=None)
	test (self)
	wait (self)
	wait_coro (self)
	Coroutine.
	get (self, buf=None, asyn=False)
	get_coro (self, buf=None)
	Coroutine.
	put (self, buf, frac_mask=None)
	put_coro (self, buf, frac_mask=None)
	Coroutine.
	update (self)
	name (self)
	role (self)
	timestep (self)
	collection_size (self)
	size (self)
	The size of the corresponding points object.
	datetime (self)
	action (self)

Data Fields
	field_id
	collection_size
	size

Protected Attributes
	_size

Detailed Description

Stored the field_id.

Definition at line 1139 of file yac.pyx.

Constructor & Destructor Documentation

__init__()

yac.Field.__init__	(		self,
			field_id,
			size = None
	)

Definition at line 1143 of file yac.pyx.

Member Function Documentation

action()

yac.Field.action

(

self

)

See also

yac_cget_action

Definition at line 1336 of file yac.pyx.

Here is the call graph for this function:

collection_size()

yac.Field.collection_size

(

self

)

See also

yac_cget_collection_size_from_field_id

Definition at line 1315 of file yac.pyx.

Here is the call graph for this function:

Here is the caller graph for this function:

create()

yac.Field.create	(		cls,
		str	field_name,
		Component	comp,
			points,
			collection_size,
		str	timestep,
		TimeUnit	timeunit,
			masks = None
	)

See also

yac_cdef_field

Definition at line 1148 of file yac.pyx.

Here is the call graph for this function:

datetime()

yac.Field.datetime

(

self

)

See also

yac_cget_field_datetime

Definition at line 1329 of file yac.pyx.

Here is the call graph for this function:

get()

yac.Field.get	(		self,
			buf = None,
			asyn = False
	)

See also

yac_cget_

Parameters

[out]	buf	receive buffer, if None a numpy array of correct size is allocated
[in]	asyn	if True the call returns immidiatly and must be completed with test or wait

Definition at line 1207 of file yac.pyx.

Here is the call graph for this function:

Here is the caller graph for this function:

get_coro()

yac.Field.get_coro	(		self,
			buf = None
	)

Coroutine.

Executes a get operation.

See also

yac_cget_async_

Parameters

[out]

buf

receive buffer, if None a numpy array of correct size is allocated

Definition at line 1238 of file yac.pyx.

Here is the call graph for this function:

name()

yac.Field.name

(

self

)

See also

yac_cget_field_name_from_field_id

Definition at line 1294 of file yac.pyx.

put()

yac.Field.put	(		self,
			buf,
			frac_mask = None
	)

See also

yac_cput_

Definition at line 1251 of file yac.pyx.

Here is the call graph for this function:

Here is the caller graph for this function:

put_coro()

yac.Field.put_coro	(		self,
			buf,
			frac_mask = None
	)

Coroutine.

Executes a put operation.

See also

yac_cput_

Definition at line 1277 of file yac.pyx.

Here is the call graph for this function:

role()

yac.Field.role

(

self

)

See also

yac_cget_role_from_field_id

Definition at line 1301 of file yac.pyx.

size()

yac.Field.size

(

self

)

The size of the corresponding points object.

Definition at line 1322 of file yac.pyx.

Here is the caller graph for this function:

test()

yac.Field.test

(

self

)

See also

yac_ctest

Definition at line 1177 of file yac.pyx.

Here is the caller graph for this function:

timestep()

yac.Field.timestep

(

self

)

See also

yac_cget_timestep_from_field_id

Definition at line 1308 of file yac.pyx.

Here is the caller graph for this function:

update()

yac.Field.update

(

self

)

See also

yac_cupdate

Definition at line 1286 of file yac.pyx.

Here is the call graph for this function:

wait()

yac.Field.wait

(

self

)

See also

yac_cwait

Definition at line 1188 of file yac.pyx.

wait_coro()

yac.Field.wait_coro

(

self

)

Coroutine.

Blocks until the communication is completed.

Definition at line 1199 of file yac.pyx.

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

_size

yac.Field._size

protected

Definition at line 1145 of file yac.pyx.

collection_size

yac.Field.collection_size

Definition at line 1263 of file yac.pyx.

field_id

yac.Field.field_id

Definition at line 1144 of file yac.pyx.

size

yac.Field.size

Definition at line 1263 of file yac.pyx.

---

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

• python/yac.pyx