Inheritance diagram for psyclone.psyir.nodes.acc_directives.ACCParallelDirective:

[legend]

Collaboration diagram for psyclone.psyir.nodes.acc_directives.ACCParallelDirective:

[legend]

Public Member Functions
def	__init__ (self, default_present=True, **kwargs)

def	gen_code (self, parent)

def	begin_string (self)

def	end_string (self)

def	default_present (self)

def	default_present (self, value)

def	fields (self)

Public Member Functions inherited from psyclone.psyir.nodes.acc_directives.ACCRegionDirective
def	validate_global_constraints (self)

def	signatures (self)

Public Member Functions inherited from psyclone.psyir.nodes.directive.RegionDirective
def	__init__ (self, ast=None, children=None, parent=None)

def	dir_body (self)

def	clauses (self)

def	gen_post_region_code (self, parent)

Public Member Functions inherited from psyclone.psyir.nodes.directive.Directive
def	create_data_movement_deep_copy_refs (self)

Public Member Functions inherited from psyclone.psyir.nodes.node.Node
def	__init__ (self, ast=None, children=None, parent=None, annotations=None)

def	__eq__ (self, other)

def	coloured_name (self, colour=True)

def	node_str (self, colour=True)

def	__str__ (self)

def	ast (self)

def	ast_end (self)

def	ast (self, ast)

def	ast_end (self, ast_end)

def	annotations (self)

def	dag (self, file_name='dag', file_format='svg')

def	dag_gen (self, graph)

def	dag_name (self)

def	args (self)

def	backward_dependence (self)

def	forward_dependence (self)

def	is_valid_location (self, new_node, position="before")

def	depth (self)

def	view (self, depth=0, colour=True, indent=" ", _index=None)

def	addchild (self, child, index=None)

def	children (self)

def	children (self, my_children)

def	parent (self)

def	siblings (self)

def	has_constructor_parent (self)

def	position (self)

def	abs_position (self)

def	root (self)

def	sameParent (self, node_2)

def	walk (self, my_type, stop_type=None, depth=None)

def	get_sibling_lists (self, my_type, stop_type=None)

def	ancestor (self, my_type, excluding=None, include_self=False, limit=None, shared_with=None)

def	kernels (self)

def	following (self, routine=True)

def	preceding (self, reverse=False, routine=True)

def	immediately_precedes (self, node_2)

def	immediately_follows (self, node_1)

def	coded_kernels (self)

def	loops (self)

def	reductions (self, reprod=None)

def	is_openmp_parallel (self)

def	lower_to_language_level (self)

def	reference_accesses (self, var_accesses)

def	scope (self)

def	replace_with (self, node, keep_name_in_context=True)

def	pop_all_children (self)

def	detach (self)

def	copy (self)

def	debug_string (self)

def	origin_string (self)

def	update_signal (self)

def	path_from (self, ancestor)

Public Member Functions inherited from psyclone.psyir.nodes.commentable_mixin.CommentableMixin
def	preceding_comment (self)

def	preceding_comment (self, comment)

def	inline_comment (self)

def	inline_comment (self, comment)

Public Attributes
	default_present

Public Attributes inherited from psyclone.psyir.nodes.node.Node
	position

Additional Inherited Members
Static Public Attributes inherited from psyclone.psyir.nodes.node.Node
int	START_DEPTH = 0

int	START_POSITION = 0

	valid_annotations = tuple()

Detailed Description

Class representing the !$ACC PARALLEL directive of OpenACC
in the PSyIR. By default it includes the 'DEFAULT(PRESENT)' clause which
means this node must either come after an EnterDataDirective or within
a DataDirective.

:param bool default_present: whether this directive includes the
    'DEFAULT(PRESENT)' clause.

Definition at line 280 of file acc_directives.py.

Constructor & Destructor Documentation

◆ init()

def psyclone.psyir.nodes.acc_directives.ACCParallelDirective.__init__	(		self,
			default_present = `True`,
		**	kwargs
	)

Class representing the !$ACC PARALLEL directive of OpenACC
in the PSyIR. By default it includes the 'DEFAULT(PRESENT)' clause which
means this node must either come after an EnterDataDirective or within
a DataDirective.

:param bool default_present: whether this directive includes the
    'DEFAULT(PRESENT)' clause.

Definition at line 291 of file acc_directives.py.

     def __init__(self, default_present=True, **kwargs):
         super().__init__(**kwargs)
         self.default_present = default_present
  

References psyclone.psyir.nodes.acc_directives.ACCParallelDirective.default_present, and psyclone.psyir.nodes.acc_directives.ACCKernelsDirective.default_present.

Member Function Documentation

◆ begin_string()

def psyclone.psyir.nodes.acc_directives.ACCParallelDirective.begin_string ( self )

Returns the beginning statement of this directive, i.e.
"acc parallel" plus any qualifiers. The backend is responsible for
adding the correct characters to mark this as a directive (e.g. "!$").

:returns: the opening statement of this directive.
:rtype: str

Definition at line 315 of file acc_directives.py.

     def begin_string(self):
         '''
         Returns the beginning statement of this directive, i.e.
         "acc parallel" plus any qualifiers. The backend is responsible for
         adding the correct characters to mark this as a directive (e.g. "!$").
  
         :returns: the opening statement of this directive.
         :rtype: str
  
         '''
         if self._default_present:
             # "default(present)" means that the compiler is to assume that
             # all data required by the parallel region is already present
             # on the device. If we've made a mistake and it isn't present
             # then we'll get a run-time error.
             return "acc parallel default(present)"
         return "acc parallel"
  

References psyclone.psyir.nodes.acc_directives.ACCParallelDirective._default_present, psyclone.psyir.nodes.acc_directives.ACCKernelsDirective._default_present, and psyclone.transformations.ACCParallelTrans._default_present.

Here is the caller graph for this function:

◆ default_present() [1/2]

def psyclone.psyir.nodes.acc_directives.ACCParallelDirective.default_present ( self )

:returns: whether the directive includes the 'default(present)' clause.
:rtype: bool

Definition at line 341 of file acc_directives.py.

     def default_present(self):
         '''
         :returns: whether the directive includes the 'default(present)' clause.
         :rtype: bool
         '''
         return self._default_present
  

References psyclone.psyir.nodes.acc_directives.ACCParallelDirective._default_present, psyclone.psyir.nodes.acc_directives.ACCKernelsDirective._default_present, and psyclone.transformations.ACCParallelTrans._default_present.

Here is the caller graph for this function:

◆ default_present() [2/2]

def psyclone.psyir.nodes.acc_directives.ACCParallelDirective.default_present	(	self,
		value
	)

:param bool value: whether the directive should include the
    'default(present)' clause.

:raises TypeError: if the given value is not a boolean.

Definition at line 349 of file acc_directives.py.

     def default_present(self, value):
         '''
         :param bool value: whether the directive should include the
             'default(present)' clause.
  
         :raises TypeError: if the given value is not a boolean.
  
         '''
         if not isinstance(value, bool):
             raise TypeError(
                 f"The ACCParallelDirective default_present property must be "
                 f"a boolean but value '{value}' has been given.")
         self._default_present = value
  

References psyclone.psyir.nodes.acc_directives.ACCParallelDirective._default_present, psyclone.psyir.nodes.acc_directives.ACCKernelsDirective._default_present, and psyclone.transformations.ACCParallelTrans._default_present.

Here is the caller graph for this function:

◆ end_string()

def psyclone.psyir.nodes.acc_directives.ACCParallelDirective.end_string ( self )

:returns: the closing statement for this directive.
:rtype: str

Definition at line 333 of file acc_directives.py.

     def end_string(self):
         '''
         :returns: the closing statement for this directive.
         :rtype: str
         '''
         return "acc end parallel"
  

Here is the caller graph for this function:

◆ fields()

def psyclone.psyir.nodes.acc_directives.ACCParallelDirective.fields ( self )

Returns a list of the names of field objects required by the Kernel
call(s) that are children of this directive.

:returns: list of names of field arguments.
:rtype: List[str]

Definition at line 364 of file acc_directives.py.

     def fields(self):
         '''
         Returns a list of the names of field objects required by the Kernel
         call(s) that are children of this directive.
  
         :returns: list of names of field arguments.
         :rtype: List[str]
         '''
         # Look-up the kernels that are children of this node
         fld_list = []
         for call in self.kernels():
             for arg in call.arguments.fields:
                 if arg not in fld_list:
                     fld_list.append(arg)
         return fld_list
  
  

References psyclone.psyir.nodes.node.Node.kernels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gen_code()

def psyclone.psyir.nodes.acc_directives.ACCParallelDirective.gen_code	(	self,
		parent
	)

Generate the elements of the f2pygen AST for this Node in the Schedule.

:param parent: node in the f2pygen AST to which to add node(s).
:type parent: :py:class:`psyclone.f2pygen.BaseGen`

Definition at line 295 of file acc_directives.py.

     def gen_code(self, parent):
         '''
         Generate the elements of the f2pygen AST for this Node in the Schedule.
  
         :param parent: node in the f2pygen AST to which to add node(s).
         :type parent: :py:class:`psyclone.f2pygen.BaseGen`
  
         '''
         self.validate_global_constraints()
  
         parent.add(DirectiveGen(parent, "acc", "begin",
                                 *self.begin_string().split()[1:]))
  
         for child in self.children:
             child.gen_code(parent)
  
         parent.add(DirectiveGen(parent, *self.end_string().split()))
  
         self.gen_post_region_code(parent)
  

Here is the call graph for this function:

Here is the caller graph for this function:

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

/home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/psyir/nodes/acc_directives.py

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ begin_string()

◆ default_present() [1/2]

◆ default_present() [2/2]

◆ end_string()

◆ fields()

◆ gen_code()

◆ init()