Mondaic

salvus.flow.simple_config.boundary

salvus.flow.simple_config.boundary salvus flow simple_config boundary

Various boundary conditions.

Classes

Absorbing

class Absorbing(
    salvus.flow.utils.deep_setters._DeepSetter,
    salvus.flow.simple_config.boundary._Base,
):
    def __init__(
        self,
        side_sets: list[str],
        taper_amplitude: float,
        width_in_meters: float,
        side_sets_are_axis_aligned: typing.Optional[bool] = None,
    ): ...

The base boundary object.

Apply first order Clayton-Enquist boundary conditions, optionally also with damping sponge layers.

Parameters
  • side_sets list[str] — Side sets at which to apply the boundary conditions. Example: ['x0', 'x1', 'y1']
  • taper_amplitude float — Taper amplitude. As a rule of thumb, a good choice is setting the taper amplitude to the central frequency in Hertz. Example: 1.07
  • width_in_meters float — Width of the absorbing layers in meters. The longer, the better. 3.5 - 5 wavelengths are typically sufficient. Example: 1.06
  • side_sets_are_axis_aligned typing.Optional[bool] — Allow the solver to make the assumption that side sets are axis aligned. This can lead to much faster absorbing layer attachment. Example: true
Methods
apply()
def apply(self, d: dict | _DeepSetter) -> None: ...

Set the contents with a dictionary.

Parameters
  • d dict | _DeepSetter — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter: ...

Return a deep copy of the object.

Returns _DeepSetter
get_dictionary()
def get_dictionary(self) -> dict: ...

Get the contents of this object as a dictionary.

Returns dict
validate()
def validate(self) -> None: ...

Validates the current state of the configuration against its schema.

Returns None

HomogeneousDirichlet

class HomogeneousDirichlet(
    salvus.flow.utils.deep_setters._DeepSetter,
    salvus.flow.simple_config.boundary._Base,
):
    def __init__(
        self,
        side_sets: list[str],
        components: typing.Optional[list[bool]] = None,
    ): ...

The base boundary object.

Homogeneous dirichlet boundary conditions

Parameters
  • side_sets list[str] — Side sets at which to apply the boundary conditions. Example: ['y0', 'x1']
  • components typing.Optional[list[bool]] — Indicator whether Dirichlet condition is applied for this coordinate axis.
Methods
apply()
def apply(self, d: dict | _DeepSetter) -> None: ...

Set the contents with a dictionary.

Parameters
  • d dict | _DeepSetter — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter: ...

Return a deep copy of the object.

Returns _DeepSetter
get_dictionary()
def get_dictionary(self) -> dict: ...

Get the contents of this object as a dictionary.

Returns dict
validate()
def validate(self) -> None: ...

Validates the current state of the configuration against its schema.

Returns None

Neumann

class Neumann(
    salvus.flow.utils.deep_setters._DeepSetter,
    salvus.flow.simple_config.boundary._Base,
):
    def __init__(self, side_sets: list[str]): ...

The base boundary object.

Apply a Neumann boundary condition

Parameters
  • side_sets list[str] — Side sets at which to apply the boundary conditions. Example: ['y0', 'x1']
Methods
apply()
def apply(self, d: dict | _DeepSetter) -> None: ...

Set the contents with a dictionary.

Parameters
  • d dict | _DeepSetter — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter: ...

Return a deep copy of the object.

Returns _DeepSetter
get_dictionary()
def get_dictionary(self) -> dict: ...

Get the contents of this object as a dictionary.

Returns dict
validate()
def validate(self) -> None: ...

Validates the current state of the configuration against its schema.

Returns None

OceanLoading

class OceanLoading(
    salvus.flow.utils.deep_setters._DeepSetter,
    salvus.flow.simple_config.boundary._Base,
):
    def __init__(self, side_sets: list[str]): ...

The base boundary object.

Apply an ocean load at the boundary

Parameters
  • side_sets list[str] — Side sets at which to apply the boundary conditions. Example: ['y0', 'x1']
Methods
apply()
def apply(self, d: dict | _DeepSetter) -> None: ...

Set the contents with a dictionary.

Parameters
  • d dict | _DeepSetter — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter: ...

Return a deep copy of the object.

Returns _DeepSetter
get_dictionary()
def get_dictionary(self) -> dict: ...

Get the contents of this object as a dictionary.

Returns dict
validate()
def validate(self) -> None: ...

Validates the current state of the configuration against its schema.

Returns None

Used in tutorials