from math import ceil as ceil
from typing import Dict as Dict
from polaris import (
Step as Step,
)
from polaris import (
Task as Task,
)
from polaris.config import PolarisConfigParser as PolarisConfigParser
from polaris.mesh.base import add_spherical_base_mesh_step
from polaris.ocean.convergence import (
get_resolution_for_task as get_resolution_for_task,
)
from polaris.ocean.convergence import (
get_timestep_for_task as get_timestep_for_task,
)
from polaris.tasks.ocean.geostrophic.analysis import Analysis as Analysis
from polaris.tasks.ocean.geostrophic.forward import Forward as Forward
from polaris.tasks.ocean.geostrophic.init import Init as Init
from polaris.tasks.ocean.geostrophic.viz import Viz as Viz
[docs]
def add_geostrophic_tasks(component):
"""
Add tasks that define variants of the geostrophic test
component : polaris.tasks.ocean.Ocean
the ocean component that the tasks will be added to
"""
for icosahedral, prefix in [(True, 'icos'), (False, 'qu')]:
filepath = (
f'{component.name}/spherical/{prefix}/geostrophic/geostrophic.cfg'
)
config = PolarisConfigParser(filepath=filepath)
config.add_from_package('polaris.ocean.convergence', 'convergence.cfg')
config.add_from_package(
'polaris.ocean.convergence.spherical', 'spherical.cfg'
)
config.add_from_package(
'polaris.tasks.ocean.geostrophic', 'geostrophic.cfg'
)
for refinement in ['space', 'time', 'both']:
for include_viz in [False, True]:
component.add_task(
Geostrophic(
component=component,
config=config,
icosahedral=icosahedral,
include_viz=include_viz,
refinement=refinement,
)
)
[docs]
class Geostrophic(Task):
"""
A convergence test for a configuration in geostrophic balance
Attributes
----------
refinement : str
Refinement type. One of 'space', 'time' or 'both' indicating both
space and time
icosahedral : bool
Whether to use icosahedral, as opposed to less regular, JIGSAW meshes
include_viz : bool
Include VizMap and Viz steps for each resolution
"""
[docs]
def __init__(
self, component, config, icosahedral, include_viz, refinement='both'
):
"""
Create the convergence test
Parameters
----------
component : polaris.tasks.ocean.Ocean
The ocean component that this task belongs to
config : polaris.config.PolarisConfigParser
A shared config parser
icosahedral : bool
Whether to use icosahedral, as opposed to less regular, JIGSAW
meshes
include_viz : bool
Include VizMap and Viz steps for each resolution
refinement : str, optional
Refinement type. One of 'space', 'time' or 'both' indicating both
space and time
"""
if icosahedral:
prefix = 'icos'
else:
prefix = 'qu'
subdir = f'spherical/{prefix}/geostrophic/convergence_{refinement}'
name = f'{prefix}_geostrophic_convergence_{refinement}'
if include_viz:
subdir = f'{subdir}/with_viz'
name = f'{name}_with_viz'
link = 'geostrophic.cfg'
super().__init__(component=component, name=name, subdir=subdir)
self.refinement = refinement
self.icosahedral = icosahedral
self.include_viz = include_viz
self.set_shared_config(config, link=link)
self._setup_steps(refinement=refinement)
def _setup_steps(self, refinement):
"""
setup steps given resolutions
Parameters
----------
refinement : str
refinement type. One of 'space', 'time' or 'both'
"""
icosahedral = self.icosahedral
config = self.config
config_filename = self.config_filename
if icosahedral:
prefix = 'icos'
else:
prefix = 'qu'
if refinement == 'time':
option = 'refinement_factors_time'
else:
option = 'refinement_factors_space'
refinement_factors = config.getlist(
'spherical_convergence', f'{prefix}_{option}', dtype=str
)
refinement_factors = ', '.join(refinement_factors)
config.set('convergence', option, value=refinement_factors)
refinement_factors = config.getlist('convergence', option, dtype=float)
base_resolution = config.getfloat(
'spherical_convergence', f'{prefix}_base_resolution'
)
config.set(
'convergence', 'base_resolution', value=f'{base_resolution:03g}'
)
# start fresh with no steps
for step in list(self.steps.values()):
self.remove_step(step)
component = self.component
resolutions = list()
timesteps = list()
case_dir = f'spherical/{prefix}/geostrophic'
analysis_dependencies: Dict[str, Dict[float, Step]] = dict(
mesh=dict(), init=dict(), forward=dict()
)
for refinement_factor in refinement_factors:
resolution = get_resolution_for_task(
config, refinement_factor, refinement=refinement
)
base_mesh_step, mesh_name = add_spherical_base_mesh_step(
prefix=prefix, min_res=resolution
)
analysis_dependencies['mesh'][refinement_factor] = base_mesh_step
name = f'{prefix}_init_{mesh_name}'
subdir = f'{case_dir}/init/{mesh_name}'
init_step = component.get_or_create_shared_step(
step_cls=Init,
subdir=subdir,
config=config,
config_filename=config_filename,
name=name,
base_mesh=base_mesh_step,
)
analysis_dependencies['init'][refinement_factor] = init_step
if resolution not in resolutions:
self.add_step(base_mesh_step, symlink=f'base_mesh/{mesh_name}')
self.add_step(init_step, symlink=f'init/{mesh_name}')
resolutions.append(resolution)
timestep, _ = get_timestep_for_task(
config, refinement_factor, refinement=refinement
)
timestep = ceil(timestep)
timesteps.append(timestep)
subdir = f'{case_dir}/forward/{mesh_name}_{timestep}s'
symlink = f'forward/{mesh_name}_{timestep}s'
name = f'{prefix}_forward_{mesh_name}_{timestep}s'
forward_step = component.get_or_create_shared_step(
step_cls=Forward,
subdir=subdir,
config=config,
config_filename=config_filename,
name=name,
refinement_factor=refinement_factor,
mesh=base_mesh_step,
init=init_step,
refinement=refinement,
)
self.add_step(forward_step, symlink=symlink)
analysis_dependencies['forward'][refinement_factor] = forward_step
if self.include_viz:
name = f'{prefix}_viz_{mesh_name}_{timestep}s'
subdir = f'{case_dir}/viz/{mesh_name}_{timestep}s'
viz_step = component.get_or_create_shared_step(
step_cls=Viz,
subdir=subdir,
config=config,
config_filename=config_filename,
name=name,
base_mesh=base_mesh_step,
init=init_step,
forward=forward_step,
mesh_name=mesh_name,
)
self.add_step(viz_step)
subdir = f'{case_dir}/convergence_{refinement}/analysis'
step = component.get_or_create_shared_step(
step_cls=Analysis,
subdir=subdir,
config=config,
config_filename=config_filename,
dependencies=analysis_dependencies,
refinement=refinement,
)
# set the resolutions and dependencies for the analysis step in case
# they have changed since the step was created
step.resolutions = resolutions
step.dependencies_dict = analysis_dependencies
if self.include_viz:
symlink = f'analysis_{refinement}'
self.add_step(step, symlink=symlink)
else:
self.add_step(step)