Skip to content

Remove stub TimeSplit and ProcessSplit objects #736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
climbfuji merged 2 commits into from
Apr 28, 2026
Merged

Remove stub TimeSplit and ProcessSplit objects #736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3eb4ddc
Remove stub TimeSplit and ProcessSplit objects
mkavulich Apr 17, 2026
788bb65
Merge branch 'develop' into feature/remove_process_time_split_logic
climbfuji Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 0 additions & 30 deletions schema/suite_v2_0.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,35 +66,9 @@

<!-- definition of suite elements -->

<xs:element name="time_split">
Copy link
Copy Markdown
Collaborator

@climbfuji climbfuji Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this has never been implemented, therefore we can remove it from schema version 2 instead of creating a new schema version 3.

<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="time_split"/>
<xs:element ref="process_split"/>
<xs:element ref="subcycle"/>
<xs:element ref="subcol"/>
<xs:element name="scheme" type="scheme_type"/>
</xs:choice>
</xs:complexType>
</xs:element>

<xs:element name="process_split">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="time_split"/>
<xs:element ref="process_split"/>
<xs:element ref="subcycle"/>
<xs:element ref="subcol"/>
<xs:element name="scheme" type="scheme_type"/>
</xs:choice>
</xs:complexType>
</xs:element>

<xs:element name="subcycle">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="time_split"/>
<xs:element ref="process_split"/>
<xs:element ref="subcycle"/>
<xs:element ref="subcol"/>
<xs:element name="scheme" type="scheme_type"/>
Expand All @@ -106,8 +80,6 @@
<xs:element name="subcol">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="time_split"/>
<xs:element ref="process_split"/>
<xs:element ref="subcycle"/>
<xs:element ref="subcol"/>
<xs:element name="scheme" type="scheme_type"/>
Expand All @@ -120,8 +92,6 @@
<xs:element name="group">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="time_split"/>
<xs:element ref="process_split"/>
<xs:element ref="subcycle"/>
<xs:element ref="subcol"/>
<xs:element name="scheme" type="scheme_type"/>
Expand Down
106 changes: 2 additions & 104 deletions scripts/suite_objects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@
_API_CONTEXT = ParseContext(filename="ccpp_suite.py")
_API_SOURCE = ParseSource(_API_SOURCE_NAME, _API_SCHEME_VAR_NAME, _API_CONTEXT)
_API_LOCAL = ParseSource(_API_SOURCE_NAME, _API_LOCAL_VAR_NAME, _API_CONTEXT)
_API_TIMESPLIT_TAG = 'time_split'
_API_PROCESSSPLIT_TAG = 'process_split'
_API_LOGGING = init_log('ccpp_suite')
set_log_to_null(_API_LOGGING)
_API_DUMMY_RUN_ENV = CCPPFrameworkEnv(_API_LOGGING,
Expand All @@ -60,8 +58,6 @@ def new_suite_object(item, context, parent, run_env, loop_count=0):
new_item = Subcycle(item, context, parent, run_env, loop_count=loop_count)
elif item.tag == 'scheme':
new_item = Scheme(item, context, parent, run_env)
elif item.tag == _API_TIMESPLIT_TAG:
new_item = TimeSplit(item, context, parent, run_env)
else:
emsg = "Unknown CCPP suite element type, '{}'"
raise CCPPError(emsg.format(item.tag))
Expand Down Expand Up @@ -786,22 +782,6 @@ def match_variable(self, var, run_env):
# end if
return found_var, dict_var, var_vdim, new_vdims, compat_obj

def in_process_split(self):
"""Find out if we are in a process-split region"""
proc_split = False
obj = self
while obj is not None:
if isinstance(obj, ProcessSplit):
proc_split = True
break
# end if
if isinstance(obj, TimeSplit):
break
# end if (other object types do not change status)
obj = obj.parent
# end while
return proc_split

def part(self, index, error=True):
"""Return one of this SuiteObject's parts raise an exception, or,
if <error> is False, just return None"""
Expand Down Expand Up @@ -1494,70 +1474,6 @@ def loop(self):

###############################################################################

class TimeSplit(SuiteObject):
"""Class to represent a group of processes to be computed in a time-split
manner -- each parameterization or other construct is called with an
state which has been updated from the previous step.
"""

def __init__(self, sub_xml, context, parent, run_env):
super().__init__('TimeSplit', context, parent, run_env)
for part in sub_xml:
new_item = new_suite_object(part, context, self, run_env)
self.add_part(new_item)
# end for

def analyze(self, phase, group, scheme_library, suite_vars, level):
# Unused arguments are for consistent analyze interface
# pylint: disable=unused-argument
"""Analyze the TimeSplit's interface to prepare for writing"""
# Handle all the suite objects inside of this group
scheme_mods = set()
for item in self.parts:
smods = item.analyze(phase, group, scheme_library,
suite_vars, level+1)
for smod in smods:
scheme_mods.add(smod)
# end for
# end for
return scheme_mods

def write(self, outfile, errcode, errmsg, indent):
"""Write code for this TimeSplit section, including contents,
to <outfile>"""
for item in self.parts:
item.write(outfile, errcode, errmsg, indent)
# end for

###############################################################################

class ProcessSplit(SuiteObject):
"""Class to represent a group of processes to be computed in a
process-split manner -- all parameterizations or other constructs are
called with the same state.
NOTE: Currently a stub
"""

def __init__(self, sub_xml, context, parent, run_env):
# Unused arguments are for consistent __init__ interface
# pylint: disable=unused-argument
super().__init__('ProcessSplit', context, parent, run_env)
raise CCPPError('ProcessSplit not yet implemented')

def analyze(self, phase, group, scheme_library, suite_vars, level):
# Unused arguments are for consistent analyze interface
# pylint: disable=unused-argument
"""Analyze the ProcessSplit's interface to prepare for writing"""
# Handle all the suite objects inside of this group
raise CCPPError('ProcessSplit not yet implemented')

def write(self, outfile, errcode, errmsg, indent):
"""Write code for this ProcessSplit section, including contents,
to <outfile>"""
raise CCPPError('ProcessSplit not yet implemented')

###############################################################################

class Group(SuiteObject):
"""Class to represent a grouping of schemes in a suite
A Group object is implemented as a subroutine callable by the API.
Expand Down Expand Up @@ -1587,12 +1503,6 @@ class Group(SuiteObject):
('end if', 1),
('#endif', -1)])

__process_types = [_API_TIMESPLIT_TAG, _API_PROCESSSPLIT_TAG]

__process_xml = {}
for gptype in __process_types:
__process_xml[gptype] = '<{ptype}></{ptype}>'.format(ptype=gptype)
# end for

def __init__(self, group_xml, transition, parent, context, run_env):
"""Initialize this Group object from <group_xml>.
Expand All @@ -1606,20 +1516,8 @@ def __init__(self, group_xml, transition, parent, context, run_env):
# Initialize the dictionary of variables internal to group
super().__init__(name, context, parent, run_env,
active_call_list=True, phase_type=transition)
# Add the items but first make sure we know the process type for
# the group (e.g., TimeSplit or ProcessSplit).
if (transition == RUN_PHASE_NAME) and ((not group_xml) or
(group_xml[0].tag not in
Group.__process_types)):
# Default is TimeSplit
tsxml = ET.fromstring(Group.__process_xml[_API_TIMESPLIT_TAG])
time_split = new_suite_object(tsxml, context, self, run_env)
add_to = time_split
self.add_part(time_split)
Comment on lines -1611 to -1618
Copy link
Copy Markdown
Collaborator

@gold2718 gold2718 Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Has the CAM-SIMA team signed off on this? CAM physics is time split but WRF physics is process split. Does the group planning on implementing WRF physics have no plans to leverage the process split class?

Copy link
Copy Markdown
Collaborator

@nusbaume nusbaume Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have, and at least @peverwhee and I are generally ok with this. Although we will certainly need to support process and time-split physics groups, it is becoming unclear if having the framework manage it is the best option, or if alternative methods (like just implementing specialized tendency_updater schemes which can be runtime controlled) is better.

We of course can always add it back in later if is decided to be handled by the framework, but for now this seems like a reasonable decision to us.

else:
add_to = self
# end if
# Add the sub objects either directly to the Group or to the TimeSplit
add_to = self
# Add the sub objects
for item in group_xml:
new_item = new_suite_object(item, context, add_to, run_env)
add_to.add_part(new_item)
Expand Down
Loading