YetAnotherCoupler 3.1.1
Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Protected Attributes
yac.Field Class Reference

Stored the field_id. More...

Collaboration diagram for yac.Field:
Collaboration graph

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.
 
 name (self)
 
 role (self)
 
 timestep (self)
 
 collection_size (self)
 
 size (self)
 The size of the corresponding points object.
 
 datetime (self)
 

Data Fields

 field_id
 
 collection_size
 
 size
 

Protected Attributes

 _size
 

Detailed Description

Stored the field_id.

Definition at line 1022 of file yac.pyx.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 1026 of file yac.pyx.

Member Function Documentation

◆ collection_size()

yac.Field.collection_size (   self)
See also
yac_cget_collection_size_from_field_id

Definition at line 1176 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 1031 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 1190 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]bufreceive buffer, if None a numpy array of correct size is allocated
[in]asynif True the call returns immidiatly and must be completed with test or wait

Definition at line 1084 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]bufreceive buffer, if None a numpy array of correct size is allocated

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

◆ put()

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

Definition at line 1122 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 1145 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 1162 of file yac.pyx.

◆ size()

yac.Field.size (   self)

The size of the corresponding points object.

Definition at line 1183 of file yac.pyx.

Here is the caller graph for this function:

◆ test()

yac.Field.test (   self)
See also
yac_ctest

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

Here is the caller graph for this function:

◆ wait()

yac.Field.wait (   self)
See also
yac_cwait

Definition at line 1066 of file yac.pyx.

◆ wait_coro()

yac.Field.wait_coro (   self)

Coroutine.

Blocks until the communication is completed.

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

◆ collection_size

yac.Field.collection_size

Definition at line 1134 of file yac.pyx.

◆ field_id

yac.Field.field_id

Definition at line 1027 of file yac.pyx.

◆ size

yac.Field.size

Definition at line 1134 of file yac.pyx.


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