Skip to content

Truncated Fourier Series¤

exponax.ic.RandomTruncatedFourierSeries ¤

Bases: BaseRandomICGenerator

Source code in exponax/ic/_truncated_fourier_series.py 
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
class RandomTruncatedFourierSeries(BaseRandomICGenerator):
    num_spatial_dims: int
    cutoff: int
    amplitude_range: tuple[int, int]
    angle_range: tuple[int, int]
    offset_range: tuple[int, int]
    std_one: bool
    max_one: bool

    def __init__(
        self,
        num_spatial_dims: int,
        *,
        cutoff: int = 5,
        amplitude_range: tuple[int, int] = (-1.0, 1.0),
        angle_range: tuple[int, int] = (0.0, 2.0 * jnp.pi),
        offset_range: tuple[int, int] = (0.0, 0.0),  # no offset by default
        std_one: bool = False,
        max_one: bool = False,
    ):
        """
        Random generator for initial states consisting of a truncated Fourier
        series with random Fourier coefficients.

        In 1d, the functional form reads:

        ```
            u(x) = o + ∑ₖ aₖ sin(k (2π/L) x) + bₖ cos(k (2 π)/L x)
        ```

        where `o` is the offset, `aₖ` and `bₖ` are the amplitudes of the sine
        and cosine terms, respectively, and `k` is the wavenumber which ranges
        up to `cutoff`. An equivalent representation is via angular offsets

        ```
            u(x) = o + ∑ₖ aₖ sin(k (2π/L) x + ϕₖ)
        ```

        where `ϕₖ` is the angular offset.

        The generalization to higher dimensions includes mixed terms and is not
        that straightforward to write down.

        Offsets are drawn accoriding to a uniform distribution in the range
        `offset_range`. Amplitudes are drawn according to a uniform distribution
        in the range `amplitude_range`. Angles (=angular offsets) are drawn
        according to a uniform distribution in the range `angle_range`.

        **Arguments**:
            - `num_spatial_dims`: The number of spatial dimensions `d`.
            - `cutoff`: The cutoff of the wavenumbers. This limits the
                "complexity" of the initial state. Note that some dynamics are
                very sensitive to high-frequency information.
            - `amplitude_range`: The range of the amplitudes. Defaults to
              `(-1.0, 1.0)`.
            - `angle_range`: The range of the angles. Defaults to `(0.0, 2π)`.
            - `offset_range`: The range of the offsets. Defaults to `(0.0,
                0.0)`, meaning **zero-mean** by default.
            - `std_one`: Whether to normalize the state to have a standard
                deviation of one. Defaults to `False`. Only works if the offset
                is zero.
            - `max_one`: Whether to normalize the state to have the maximum
                absolute value of one. Defaults to `False`. Only one of
                `std_one` and `max_one` can be `True`.
        """
        if offset_range == (0.0, 0.0) and std_one:
            raise ValueError("Cannot have non-zero offset and `std_one=True`.")
        if std_one and max_one:
            raise ValueError("Cannot have `std_one=True` and `max_one=True`.")
        self.num_spatial_dims = num_spatial_dims

        self.cutoff = cutoff
        self.amplitude_range = amplitude_range
        self.angle_range = angle_range
        self.offset_range = offset_range
        self.std_one = std_one
        self.max_one = max_one

    def __call__(
        self, num_points: int, *, key: PRNGKeyArray
    ) -> Float[Array, "1 ... N"]:
        fourier_noise_shape = (1,) + wavenumber_shape(self.num_spatial_dims, num_points)
        amplitude_key, angle_key, offset_key = jr.split(key, 3)

        amplitude = jr.uniform(
            amplitude_key,
            shape=fourier_noise_shape,
            minval=self.amplitude_range[0],
            maxval=self.amplitude_range[1],
        )
        angle = jr.uniform(
            angle_key,
            shape=fourier_noise_shape,
            minval=self.angle_range[0],
            maxval=self.angle_range[1],
        )

        fourier_noise = amplitude * jnp.exp(1j * angle)

        low_pass_filter = low_pass_filter_mask(
            self.num_spatial_dims, num_points, cutoff=self.cutoff, axis_separate=True
        )

        fourier_noise = fourier_noise * low_pass_filter

        offset = jr.uniform(
            offset_key,
            shape=(1,),
            minval=self.offset_range[0],
            maxval=self.offset_range[1],
        )[0]
        fourier_noise = (
            fourier_noise.flatten().at[0].set(offset).reshape(fourier_noise_shape)
        )

        fourier_noise = fourier_noise * build_scaling_array(
            self.num_spatial_dims, num_points
        )

        u = jnp.fft.irfftn(
            fourier_noise,
            s=spatial_shape(self.num_spatial_dims, num_points),
            axes=space_indices(self.num_spatial_dims),
        )

        if self.std_one:
            u = u / jnp.std(u)

        if self.max_one:
            u /= jnp.max(jnp.abs(u))

        return u
__init__ ¤
__init__(
    num_spatial_dims: int,
    *,
    cutoff: int = 5,
    amplitude_range: tuple[int, int] = (-1.0, 1.0),
    angle_range: tuple[int, int] = (0.0, 2.0 * jnp.pi),
    offset_range: tuple[int, int] = (0.0, 0.0),
    std_one: bool = False,
    max_one: bool = False
)

Random generator for initial states consisting of a truncated Fourier series with random Fourier coefficients.

In 1d, the functional form reads:

    u(x) = o + ∑ₖ aₖ sin(k (2π/L) x) + bₖ cos(k (2 π)/L x)

where o is the offset, aₖ and bₖ are the amplitudes of the sine and cosine terms, respectively, and k is the wavenumber which ranges up to cutoff. An equivalent representation is via angular offsets

    u(x) = o + ∑ₖ aₖ sin(k (2π/L) x + ϕₖ)

where ϕₖ is the angular offset.

The generalization to higher dimensions includes mixed terms and is not that straightforward to write down.

Offsets are drawn accoriding to a uniform distribution in the range offset_range. Amplitudes are drawn according to a uniform distribution in the range amplitude_range. Angles (=angular offsets) are drawn according to a uniform distribution in the range angle_range.

Arguments: - num_spatial_dims: The number of spatial dimensions d. - cutoff: The cutoff of the wavenumbers. This limits the "complexity" of the initial state. Note that some dynamics are very sensitive to high-frequency information. - amplitude_range: The range of the amplitudes. Defaults to (-1.0, 1.0). - angle_range: The range of the angles. Defaults to (0.0, 2π). - offset_range: The range of the offsets. Defaults to (0.0, 0.0), meaning zero-mean by default. - std_one: Whether to normalize the state to have a standard deviation of one. Defaults to False. Only works if the offset is zero. - max_one: Whether to normalize the state to have the maximum absolute value of one. Defaults to False. Only one of std_one and max_one can be True.

Source code in exponax/ic/_truncated_fourier_series.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def __init__(
    self,
    num_spatial_dims: int,
    *,
    cutoff: int = 5,
    amplitude_range: tuple[int, int] = (-1.0, 1.0),
    angle_range: tuple[int, int] = (0.0, 2.0 * jnp.pi),
    offset_range: tuple[int, int] = (0.0, 0.0),  # no offset by default
    std_one: bool = False,
    max_one: bool = False,
):
    """
    Random generator for initial states consisting of a truncated Fourier
    series with random Fourier coefficients.

    In 1d, the functional form reads:

    ```
        u(x) = o + ∑ₖ aₖ sin(k (2π/L) x) + bₖ cos(k (2 π)/L x)
    ```

    where `o` is the offset, `aₖ` and `bₖ` are the amplitudes of the sine
    and cosine terms, respectively, and `k` is the wavenumber which ranges
    up to `cutoff`. An equivalent representation is via angular offsets

    ```
        u(x) = o + ∑ₖ aₖ sin(k (2π/L) x + ϕₖ)
    ```

    where `ϕₖ` is the angular offset.

    The generalization to higher dimensions includes mixed terms and is not
    that straightforward to write down.

    Offsets are drawn accoriding to a uniform distribution in the range
    `offset_range`. Amplitudes are drawn according to a uniform distribution
    in the range `amplitude_range`. Angles (=angular offsets) are drawn
    according to a uniform distribution in the range `angle_range`.

    **Arguments**:
        - `num_spatial_dims`: The number of spatial dimensions `d`.
        - `cutoff`: The cutoff of the wavenumbers. This limits the
            "complexity" of the initial state. Note that some dynamics are
            very sensitive to high-frequency information.
        - `amplitude_range`: The range of the amplitudes. Defaults to
          `(-1.0, 1.0)`.
        - `angle_range`: The range of the angles. Defaults to `(0.0, 2π)`.
        - `offset_range`: The range of the offsets. Defaults to `(0.0,
            0.0)`, meaning **zero-mean** by default.
        - `std_one`: Whether to normalize the state to have a standard
            deviation of one. Defaults to `False`. Only works if the offset
            is zero.
        - `max_one`: Whether to normalize the state to have the maximum
            absolute value of one. Defaults to `False`. Only one of
            `std_one` and `max_one` can be `True`.
    """
    if offset_range == (0.0, 0.0) and std_one:
        raise ValueError("Cannot have non-zero offset and `std_one=True`.")
    if std_one and max_one:
        raise ValueError("Cannot have `std_one=True` and `max_one=True`.")
    self.num_spatial_dims = num_spatial_dims

    self.cutoff = cutoff
    self.amplitude_range = amplitude_range
    self.angle_range = angle_range
    self.offset_range = offset_range
    self.std_one = std_one
    self.max_one = max_one
__call__ ¤
__call__(
    num_points: int, *, key: PRNGKeyArray
) -> Float[Array, "1 ... N"]
Source code in exponax/ic/_truncated_fourier_series.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
def __call__(
    self, num_points: int, *, key: PRNGKeyArray
) -> Float[Array, "1 ... N"]:
    fourier_noise_shape = (1,) + wavenumber_shape(self.num_spatial_dims, num_points)
    amplitude_key, angle_key, offset_key = jr.split(key, 3)

    amplitude = jr.uniform(
        amplitude_key,
        shape=fourier_noise_shape,
        minval=self.amplitude_range[0],
        maxval=self.amplitude_range[1],
    )
    angle = jr.uniform(
        angle_key,
        shape=fourier_noise_shape,
        minval=self.angle_range[0],
        maxval=self.angle_range[1],
    )

    fourier_noise = amplitude * jnp.exp(1j * angle)

    low_pass_filter = low_pass_filter_mask(
        self.num_spatial_dims, num_points, cutoff=self.cutoff, axis_separate=True
    )

    fourier_noise = fourier_noise * low_pass_filter

    offset = jr.uniform(
        offset_key,
        shape=(1,),
        minval=self.offset_range[0],
        maxval=self.offset_range[1],
    )[0]
    fourier_noise = (
        fourier_noise.flatten().at[0].set(offset).reshape(fourier_noise_shape)
    )

    fourier_noise = fourier_noise * build_scaling_array(
        self.num_spatial_dims, num_points
    )

    u = jnp.fft.irfftn(
        fourier_noise,
        s=spatial_shape(self.num_spatial_dims, num_points),
        axes=space_indices(self.num_spatial_dims),
    )

    if self.std_one:
        u = u / jnp.std(u)

    if self.max_one:
        u /= jnp.max(jnp.abs(u))

    return u