YetAnotherCoupler 3.2.0
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
yac.YAC Class Reference

Initializies a YAC instance and provides further functionality. More...

Collaboration diagram for yac.YAC:
Collaboration graph

Public Member Functions

 __init__ (self, comm=None, default_instance=False)
 
 default_instance (cls)
 
 from_id (cls, id)
 
 __del__ (self)
 
 cleanup (self)
 
 def_comp (self, str comp_name)
 
 def_comps (self, comp_names=[])
 
 predef_comp (self, str comp_name)
 
 def_datetime (self, start_datetime, end_datetime)
 
 start_datetime (self)
 
 end_datetime (self)
 
 sync_def (self)
 
 def_couple (self, str src_comp, str src_grid, src_field, str tgt_comp, str tgt_grid, tgt_field, str coupling_timestep, TimeUnit timeunit, Reduction time_reduction, interp_stack, src_lag=0, tgt_lag=0, weight_file=None, mapping_on_source=1, scale_factor=1.0, scale_summand=0.0, src_masks_names=None, tgt_mask_name=None)
 
 enddef (self)
 
 component_names (self)
 
 grid_names (self)
 
 get_comp_grid_names (self, comp_name)
 
 get_field_names (self, str comp_name, str grid_name)
 
 get_field_id (self, str comp_name, str grid_name, str field_name)
 
 get_field_timestep (self, str comp_name, str grid_name, str field_name)
 
 get_field_role (self, str comp_name, str grid_name, str field_name)
 
 get_field_collection_size (self, str comp_name, str grid_name, str field_name)
 
 get_field_frac_mask_fallback_value (self, str comp_name, str grid_name, str field_name)
 
 enable_field_frac_mask (self, str comp_name, str grid_name, str field_name, _np.float64 frac_mask_fallback_value)
 
 def_component_metadata (self, str comp_name, bytes metadata)
 
 def_grid_metadata (self, str grid_name, bytes metadata)
 
 def_field_metadata (self, str comp_name, str grid_name, str field_name, bytes metadata)
 
 get_component_metadata (self, str comp_name)
 
 get_grid_metadata (self, str grid_name)
 
 get_field_metadata (self, str comp_name, str grid_name, str field_name)
 
 get_comps_comm (self, comp_names)
 
 read_config_yaml (self, str yaml_file)
 

Data Fields

 instance_id
 
 owned_instance
 

Detailed Description

Initializies a YAC instance and provides further functionality.

The destructor finalizes the YAC instance by calling yac_cfinalize_instance

Definition at line 471 of file yac.pyx.

Constructor & Destructor Documentation

◆ __init__()

yac.YAC.__init__ (   self,
  comm = None,
  default_instance = False 
)
See also
yac_cinit_instance

Definition at line 477 of file yac.pyx.

Here is the call graph for this function:

◆ __del__()

yac.YAC.__del__ (   self)

Definition at line 518 of file yac.pyx.

Here is the call graph for this function:

Member Function Documentation

◆ cleanup()

yac.YAC.cleanup (   self)
See also
yac_ccleanup_instance

Definition at line 521 of file yac.pyx.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ component_names()

yac.YAC.component_names (   self)
See also
yac_cget_comp_names

Definition at line 685 of file yac.pyx.

Here is the call graph for this function:

◆ def_comp()

yac.YAC.def_comp (   self,
str  comp_name 
)
See also
yac_cdef_comp_instance

Definition at line 530 of file yac.pyx.

Here is the call graph for this function:

◆ def_component_metadata()

yac.YAC.def_component_metadata (   self,
str  comp_name,
bytes  metadata 
)
See also
yac_cdef_component_metadata

Definition at line 790 of file yac.pyx.

Here is the call graph for this function:

◆ def_comps()

yac.YAC.def_comps (   self,
  comp_names = [] 
)
See also
yac_cdef_comps_instance

Definition at line 540 of file yac.pyx.

Here is the call graph for this function:

◆ def_couple()

yac.YAC.def_couple (   self,
str  src_comp,
str  src_grid,
  src_field,
str  tgt_comp,
str  tgt_grid,
  tgt_field,
str  coupling_timestep,
TimeUnit  timeunit,
Reduction  time_reduction,
  interp_stack,
  src_lag = 0,
  tgt_lag = 0,
  weight_file = None,
  mapping_on_source = 1,
  scale_factor = 1.0,
  scale_summand = 0.0,
  src_masks_names = None,
  tgt_mask_name = None 
)
See also
yac_cdef_couple_instance

Definition at line 621 of file yac.pyx.

Here is the call graph for this function:

◆ def_datetime()

yac.YAC.def_datetime (   self,
  start_datetime,
  end_datetime 
)
See also
yac_cdef_datetime_instance

The parameters can be given either as a string in iso8601 format or as datetime objects

Definition at line 568 of file yac.pyx.

◆ def_field_metadata()

yac.YAC.def_field_metadata (   self,
str  comp_name,
str  grid_name,
str  field_name,
bytes  metadata 
)
See also
yac_cdef_field_metadata

Definition at line 806 of file yac.pyx.

Here is the call graph for this function:

◆ def_grid_metadata()

yac.YAC.def_grid_metadata (   self,
str  grid_name,
bytes  metadata 
)
See also
yac_cdef_grid_metadata

Definition at line 798 of file yac.pyx.

Here is the call graph for this function:

◆ default_instance()

yac.YAC.default_instance (   cls)

Definition at line 508 of file yac.pyx.

Here is the call graph for this function:

◆ enable_field_frac_mask()

yac.YAC.enable_field_frac_mask (   self,
str  comp_name,
str  grid_name,
str  field_name,
_np.float64  frac_mask_fallback_value 
)
See also
yac_cenable_field_frac_mask

Definition at line 778 of file yac.pyx.

Here is the call graph for this function:

◆ end_datetime()

yac.YAC.end_datetime (   self)
See also
yac_cget_end_datetime_instance (datetime.datetime, read-only).

Definition at line 607 of file yac.pyx.

Here is the call graph for this function:

◆ enddef()

yac.YAC.enddef (   self)
See also
yac_cenddef_instance

Definition at line 677 of file yac.pyx.

Here is the call graph for this function:

◆ from_id()

yac.YAC.from_id (   cls,
  id 
)

Definition at line 512 of file yac.pyx.

Here is the caller graph for this function:

◆ get_comp_grid_names()

yac.YAC.get_comp_grid_names (   self,
  comp_name 
)
See also
yac_cget_comp_grid_names

Definition at line 708 of file yac.pyx.

Here is the call graph for this function:

◆ get_component_metadata()

yac.YAC.get_component_metadata (   self,
str  comp_name 
)
See also
yac_cget_component_metadata

Definition at line 817 of file yac.pyx.

Here is the call graph for this function:

◆ get_comps_comm()

yac.YAC.get_comps_comm (   self,
  comp_names 
)
See also
yac_cget_comps_comm

Definition at line 843 of file yac.pyx.

Here is the call graph for this function:

◆ get_field_collection_size()

yac.YAC.get_field_collection_size (   self,
str  comp_name,
str  grid_name,
str  field_name 
)
See also
yac_cget_field_collection_size

Definition at line 760 of file yac.pyx.

Here is the call graph for this function:

◆ get_field_frac_mask_fallback_value()

yac.YAC.get_field_frac_mask_fallback_value (   self,
str  comp_name,
str  grid_name,
str  field_name 
)
See also
yac_cget_field_frac_mask_fallback_value

Definition at line 769 of file yac.pyx.

Here is the call graph for this function:

◆ get_field_id()

yac.YAC.get_field_id (   self,
str  comp_name,
str  grid_name,
str  field_name 
)
See also
yac_cget_field_id

Definition at line 733 of file yac.pyx.

◆ get_field_metadata()

yac.YAC.get_field_metadata (   self,
str  comp_name,
str  grid_name,
str  field_name 
)
See also
yac_cget_field_metadata

Definition at line 833 of file yac.pyx.

Here is the call graph for this function:

◆ get_field_names()

yac.YAC.get_field_names (   self,
str  comp_name,
str  grid_name 
)
See also
yac_cget_field_names

Definition at line 719 of file yac.pyx.

Here is the call graph for this function:

◆ get_field_role()

yac.YAC.get_field_role (   self,
str  comp_name,
str  grid_name,
str  field_name 
)
See also
yac_cget_field_role

Definition at line 751 of file yac.pyx.

◆ get_field_timestep()

yac.YAC.get_field_timestep (   self,
str  comp_name,
str  grid_name,
str  field_name 
)
See also
yac_cget_field_timestep

Definition at line 742 of file yac.pyx.

Here is the call graph for this function:

◆ get_grid_metadata()

yac.YAC.get_grid_metadata (   self,
str  grid_name 
)
See also
yac_cget_grid_metadata

Definition at line 825 of file yac.pyx.

Here is the call graph for this function:

◆ grid_names()

yac.YAC.grid_names (   self)
See also
yac_cget_grid_names

Definition at line 697 of file yac.pyx.

Here is the call graph for this function:

◆ predef_comp()

yac.YAC.predef_comp (   self,
str  comp_name 
)
See also
yac_cpredef_comp_instance

Definition at line 558 of file yac.pyx.

Here is the call graph for this function:

◆ read_config_yaml()

yac.YAC.read_config_yaml (   self,
str  yaml_file 
)
See also
yac_cread_config_yaml_instance

Definition at line 858 of file yac.pyx.

Here is the call graph for this function:

◆ start_datetime()

yac.YAC.start_datetime (   self)
See also
yac_cget_start_datetime_instance (datetime.datetime, read-only).

Definition at line 599 of file yac.pyx.

Here is the call graph for this function:

◆ sync_def()

yac.YAC.sync_def (   self)
See also
yac_csync_def_instance

Definition at line 614 of file yac.pyx.

Here is the call graph for this function:

Field Documentation

◆ instance_id

yac.YAC.instance_id

Definition at line 503 of file yac.pyx.

◆ owned_instance

yac.YAC.owned_instance

Definition at line 504 of file yac.pyx.


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