YAC 3.12.0
Yet Another Coupler
Loading...
Searching...
No Matches
yac.InterpolationStack Class Reference
Collaboration diagram for yac.InterpolationStack:
Collaboration graph

Public Member Functions

 __init__ (self)
 
 from_string_yaml (cls, str interp_stack_string)
 
 from_string_json (cls, str interp_stack_string)
 
 add_average (self, AverageReductionType reduction_type=AverageReductionType.AVG_ARITHMETIC, bool partial_coverage=False)
 
 add_ncc (self, NCCReductionType reduction_type=NCCReductionType.AVG, bool partial_coverage=False)
 
 add_nnn (self, NNNReductionType reduction_type=NNNReductionType.AVG, int n=1, _np.float64 max_search_distance=0.0, _np.float64 scale=1.0)
 
 add_rbf (self, int n=9, _np.float64 max_search_distance=0.0, _np.float64 scale=1.487973e+01)
 
 add_conservative (self, int order=1, bool enforced_conserv=False, bool partial_coverage=False, ConservNormalizationType normalisation=ConservNormalizationType.DESTAREA)
 
 add_spmap (self, _np.float64 spread_distance=0.0, _np.float64 max_search_distance=0.0, SPMAPWeightType weight_type=SPMAPWeightType.AVG, SPMAPScaleType scale_type=SPMAPScaleType.NONE, _np.float64 src_sphere_radius=1.0, str src_filename=None, str src_varname=None, int src_min_global_id=0, _np.float64 tgt_sphere_radius=1.0, str tgt_filename=None, str tgt_varname=None, int tgt_min_global_id=0)
 
 add_hcsbb (self)
 
 add_user_file (self, str filename, UserFileOnMissingFile on_missing_file=UserFileOnMissingFile.ERROR, UserFileOnSuccess on_success=UserFileOnSuccess.CONT)
 
 add_fixed (self, _np.float64 value=_np.finfo(_np.double).max)
 
 add_check (self, str constructor_key, str do_search_key)
 
 add_creep (self, int creep_distance=-1)
 
 __del__ (self)
 

Data Fields

 interp_stack_id
 

Detailed Description

Definition at line 2032 of file yac.pyx.

Constructor & Destructor Documentation

◆ __init__()

yac.InterpolationStack.__init__ ( self)
See also
yac_cget_interp_stack_config

Definition at line 2033 of file yac.pyx.

Here is the call graph for this function:

◆ __del__()

yac.InterpolationStack.__del__ ( self)
See also
yac_cfree_interp_stack_config

Definition at line 2220 of file yac.pyx.

Here is the call graph for this function:

Member Function Documentation

◆ add_average()

yac.InterpolationStack.add_average ( self,
AverageReductionType reduction_type = AverageReductionType.AVG_ARITHMETIC,
bool partial_coverage = False )
See also
yac_cadd_interp_stack_config_average

Definition at line 2063 of file yac.pyx.

Here is the call graph for this function:

◆ add_check()

yac.InterpolationStack.add_check ( self,
str constructor_key,
str do_search_key )
See also
yac_cadd_interp_stack_config_check

Definition at line 2201 of file yac.pyx.

Here is the call graph for this function:

◆ add_conservative()

yac.InterpolationStack.add_conservative ( self,
int order = 1,
bool enforced_conserv = False,
bool partial_coverage = False,
ConservNormalizationType normalisation = ConservNormalizationType.DESTAREA )
See also
yac_cadd_interp_stack_config_conservative

Definition at line 2109 of file yac.pyx.

Here is the call graph for this function:

◆ add_creep()

yac.InterpolationStack.add_creep ( self,
int creep_distance = -1 )
See also
yac_cadd_interp_stack_config_creep

Definition at line 2211 of file yac.pyx.

Here is the call graph for this function:

◆ add_fixed()

yac.InterpolationStack.add_fixed ( self,
_np.float64 value = _np.finfo(_np.double).max )
See also
yac_cadd_interp_stack_config_fixed

Definition at line 2194 of file yac.pyx.

Here is the call graph for this function:

◆ add_hcsbb()

yac.InterpolationStack.add_hcsbb ( self)
See also
yac_cadd_interp_stack_config_hcsbb

Definition at line 2173 of file yac.pyx.

Here is the call graph for this function:

◆ add_ncc()

yac.InterpolationStack.add_ncc ( self,
NCCReductionType reduction_type = NCCReductionType.AVG,
bool partial_coverage = False )
See also
yac_cadd_interp_stack_config_ncc

Definition at line 2074 of file yac.pyx.

Here is the call graph for this function:

◆ add_nnn()

yac.InterpolationStack.add_nnn ( self,
NNNReductionType reduction_type = NNNReductionType.AVG,
int n = 1,
_np.float64 max_search_distance = 0.0,
_np.float64 scale = 1.0 )
See also
yac_cadd_interp_stack_config_nnn

Definition at line 2085 of file yac.pyx.

Here is the call graph for this function:

◆ add_rbf()

yac.InterpolationStack.add_rbf ( self,
int n = 9,
_np.float64 max_search_distance = 0.0,
_np.float64 scale = 1.487973e+01 )
See also
yac_cadd_interp_stack_config_rbf

Definition at line 2098 of file yac.pyx.

Here is the call graph for this function:

◆ add_spmap()

yac.InterpolationStack.add_spmap ( self,
_np.float64 spread_distance = 0.0,
_np.float64 max_search_distance = 0.0,
SPMAPWeightType weight_type = SPMAPWeightType.AVG,
SPMAPScaleType scale_type = SPMAPScaleType.NONE,
_np.float64 src_sphere_radius = 1.0,
str src_filename = None,
str src_varname = None,
int src_min_global_id = 0,
_np.float64 tgt_sphere_radius = 1.0,
str tgt_filename = None,
str tgt_varname = None,
int tgt_min_global_id = 0 )
See also
yac_cadd_interp_stack_config_spmap

Definition at line 2123 of file yac.pyx.

Here is the call graph for this function:

◆ add_user_file()

yac.InterpolationStack.add_user_file ( self,
str filename,
UserFileOnMissingFile on_missing_file = UserFileOnMissingFile.ERROR,
UserFileOnSuccess on_success = UserFileOnSuccess.CONT )
See also
yac_cadd_interp_stack_config_user_file

Definition at line 2180 of file yac.pyx.

Here is the call graph for this function:

◆ from_string_json()

yac.InterpolationStack.from_string_json ( cls,
str interp_stack_string )

Definition at line 2054 of file yac.pyx.

Here is the call graph for this function:

◆ from_string_yaml()

yac.InterpolationStack.from_string_yaml ( cls,
str interp_stack_string )

Definition at line 2044 of file yac.pyx.

Here is the call graph for this function:

Field Documentation

◆ interp_stack_id

yac.InterpolationStack.interp_stack_id

Definition at line 2041 of file yac.pyx.


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