assemble ignores keyword arguments for 0-forms and 1-forms

Abierto
#5,435 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
74/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python

Línea de trabajo

Comienza en el punto de entrada assemble y en get_assembler; después, inspecciona cómo el assembler seleccionado recibe argumentos de palabra clave para 0-forms y 1-forms. Compara los nombres aceptados con los nombres proporcionados y añade cobertura para las opciones desconocidas, el error tipográfico zero_bc_node y los bcs ignorados; el trabajo estará terminado cuando las palabras clave ilegales generen TypeError y las opciones válidas sigan funcionando.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

assemble accepts keyword arguments that it cannot use, and then it ignores them. This happens for
0-forms and 1-forms. get_assembler reads a fixed list of names out of kwargs and drops the rest.
The user gets no error and no warning.

Three examples, all of which assemble the same vector:

from firedrake import *

mesh = UnitSquareMesh(2, 2)
V = FunctionSpace(mesh, "CG", 1)
u = Function(V).assign(1)
F = inner(u, TestFunction(V)) * dx

assemble(F, zero_bc_node=False)   # a typo for zero_bc_nodes
assemble(F, sub_mat_type="baij")  # only applies to matrices
assemble(F, unknown_option=True)  # not an option of assemble at all

0-forms are worse, because ZeroFormAssembler keeps only form_compiler_parameters:

assemble(inner(u, u) * dx, bcs=DirichletBC(V, 0, 1))  # the bcs do nothing

The 2-form case behaves as I expect, because TwoFormAssembler gets **kwargs and Python does the
check for us:

assemble(inner(TrialFunction(V), TestFunction(V)) * dx, unknown_option=True)
# TypeError: ExplicitMatrixAssembler.__init__() got an unexpected keyword argument 'unknown_option'

An illegal keyword argument to a 1-form must fail in the same way. The typo is the dangerous case.
The user thinks that they turned an option off, but they get the default behaviour and no message.

To correct this, compare the given names with the names that the selected assembler accepts, and
raise a TypeError for the names that are left over.

This is not new. It is the behaviour on main today. It came up in a review of #5258:
https://github.com/firedrakeproject/firedrake/pull/5258#discussion_r3949655655


Written by Claude (Claude Code), posted from @pbrubeck's account.

Lenguaje dominante
Python
Estrellas
684
Forks
204
Merge medio
4 d 14 h
PR fusionados (30 d)
46

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de firedrakeproject/firedrake

Todos los issues de firedrakeproject/firedrake

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.