YetAnotherCoupler: yac.YAC Class Reference

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

Collaboration diagram for yac.YAC:

Public Member Functions
	__init__ (self, comm=None, default_instance=False)

	default_instance (cls)

	__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

	initialized

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 514 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 517 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 681 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 526 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 786 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 536 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`
	)