YetAnotherCoupler 3.4.0
Loading...
Searching...
No Matches
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)
 
 set_config_output_file (self, str filename, ConfigOutputFormat fileformat, ConfigOutputSyncLoc sync_location, bool include_definitions=False)
 

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 529 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 535 of file yac.pyx.

Here is the call graph for this function:

◆ __del__()

yac.YAC.__del__ ( self)

Definition at line 576 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 579 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 743 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 588 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 848 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 598 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 679 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 626 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 864 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 856 of file yac.pyx.

Here is the call graph for this function:

◆ default_instance()

yac.YAC.default_instance ( cls)

Definition at line 566 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 836 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 665 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 735 of file yac.pyx.

Here is the call graph for this function:

◆ from_id()

yac.YAC.from_id ( cls,
id )

Definition at line 570 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 766 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 875 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 901 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 818 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 827 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 791 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 891 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 777 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 809 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 800 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 883 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 755 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 616 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 916 of file yac.pyx.

Here is the call graph for this function:

◆ set_config_output_file()

yac.YAC.set_config_output_file ( self,
str filename,
ConfigOutputFormat fileformat,
ConfigOutputSyncLoc sync_location,
bool include_definitions = False )
See also
yac_cset_config_output_file_instance

Definition at line 923 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 657 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 672 of file yac.pyx.

Here is the call graph for this function:

Field Documentation

◆ instance_id

yac.YAC.instance_id

Definition at line 561 of file yac.pyx.

◆ owned_instance

yac.YAC.owned_instance

Definition at line 562 of file yac.pyx.


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