YAC: yac.Field Class Reference

Searching...

No Matches

Store 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.

	get_raw (self, buf, frac_mask=None, asyn=False)

	put (self, buf, frac_mask=None)

	put_coro (self, buf, frac_mask=None)
	Coroutine.

	update (self)

	exchange (cls, send_field, recv_field, send_buf, recv_buf=None, send_frac_mask=None)

	name (self)

	grid_name (self)

	component_name (self)

	role (self)

	timestep (self)

	collection_size (self)

	size (self)
	The size of the corresponding points object.

	datetime (self)

	action (self)

	get_raw_interp_weights_data (self)

	get_raw_interp_weights_data_csr (self)

Data Fields
	field_id

	collection_size

	size

Protected Attributes
	_size

Detailed Description

Store the field_id.

Definition at line 1763 of file yac.pyx.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 1767 of file yac.pyx.

Member Function Documentation

◆ action()

yac.Field.action ( self )

See also: yac_cget_action

Can be checked before calling get/get_raw to determine whether the next call will actually receive data. If it is Action.NONE or Action.OUT_OF_BOUND, get/get_raw will return None instead of data and update can be called instead.

Definition at line 2093 of file yac.pyx.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collection_size()

yac.Field.collection_size ( self )

See also: yac_cget_collection_size_from_field_id

Definition at line 2071 of file yac.pyx.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ component_name()

yac.Field.component_name ( self )

See also: yac_cget_component_name_from_field_id

Definition at line 2048 of file yac.pyx.

◆ 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 1772 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 2085 of file yac.pyx.

Here is the call graph for this function:

◆ exchange()

yac.Field.exchange	(	cls,
		send_field,
		recv_field,
		send_buf,
		recv_buf = None,
		send_frac_mask = None )

See also: yac_cexchange_frac_

Returns: a tuple (data, send_info, recv_info). If no data is to be received on the recv side (i.e. recv_info is Action.NONE or Action.OUT_OF_BOUND), the send side is handled via put, update is called on the recv side and data is None.

Definition at line 1981 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_ and variants

Parameters

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

Returns: a tuple (data, action). If no data is to be received (i.e. action is Action.NONE or Action.OUT_OF_BOUND), update is called instead and data is None.

Definition at line 1831 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 1869 of file yac.pyx.

Here is the call graph for this function:

◆ get_raw()

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

See also: yac_cget_raw_ and variants

Parameters

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

Returns: a tuple (data, frac_mask, action). If no data is to be received (i.e. action is Action.NONE or Action.OUT_OF_BOUND), update is called instead and data and frac_mask are None.

Definition at line 1882 of file yac.pyx.

Here is the call graph for this function: