Side-chain field on the Apple GPU: the states' direct sums in Metal, bit for bit

RESULT-CHANGING on the CPU (ulp level): the B factor's exp in EvaluatorCPU::Contribution is
BraggExp (bragg_integration/BraggExp.h, at most 0.53 ulp) instead of the libm expf, so that the
Apple GPU, whose exp no host function reproduces, computes the same bits.

MakeSideChainFieldEvaluatorCPU takes a `gpu` flag (the refinement passes settings.gpu); on macOS the
evaluator's Contribution() and the per-state sums of Evaluate() then run on the Apple GPU
(SideChainFieldMetal.mm/.metal): one thread per reflection and state, as SideChainFieldGPU.cu's
contribution_kernel, the evaluator's tables uploaded once, states in batches of 32 so that the
GPU's buffer stays small beside the states' own. Fast math and contraction off - also over the
BraggExp prepended to the kernel source, which a first version left contracted (91 of 60000
values 1-2 ulp off). The likelihood over the combinations stays on the CPU (double). Where the
GPU is hidden (--no-gpu) or fails (one warning) the CPU does the same sums.

SideChainFieldMetal_BitIdenticalToCPU ([portable][Metal]): 20000 reflections, P212121, 70
six-atom states (three batches): every contribution the same bits, every combination's -ln L equal.

M6 Mac mini, rugnux --mode refine of an open-arm set's merged MTZ and refined model, on top of the
Metal gradient (previous commit):
  9s02 (20355 atoms, 306298 reflections, 5 NCS copies): side-chain field 149.0 -> 30.4 s, refinement
       309 -> 184 s wall; R-work 0.2254 / R-free 0.2390 both.
  9zlo: field 7.6 -> 2.4 s, 45.8 -> 41.3 s; R unchanged.
  --no-gpu on 9zlo: the refined model byte-identical to the build before (the field moved nothing).
Not run here: SideChainFieldTest.cpp's [Refinement] cases (jfjoch_test is not built on macOS).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UqXYdJDrM65gxsCn2PrbfK
This commit is contained in:
Filip LeonarskiandClaude Opus 5.5 committed 2026-11-16 07:56:15 +01:00
1 parent 88330f395f
commit 3a4dcba3bd
10 files changed
+411 -9

No files matched your search

+4 -1
View File
@@ -342,7 +342,7 @@ mask 15-18% at low resolution. Inside a full `rugnux --model` run of a 5,000-ato
## Apple GPUs (Metal)
A macOS build has no CUDA, and four engines run on the Apple GPU instead (none under
A macOS build has no CUDA, and five engines run on the Apple GPU instead (none under
`rugnux --no-gpu`; where the GPU fails, the CPU takes over with a warning):
- **Bragg integration** (`BraggIntegrationEngineMetal.mm`, `.metal`) - the CPU engine with its
@@ -362,6 +362,9 @@ A macOS build has no CUDA, and four engines run on the Apple GPU instead (none u
engine's gradient over the FFT method's map, each atom's box walked by one SIMD group as under CUDA;
the CPU's points, summed in single precision, so the gradient is the CPU's to a few parts in 1e5
(a macOS CI step checks it against the CPU's). It halves the time of a refinement on the CPU engine.
- **Side-chain field** (`SideChainFieldMetal.mm`, `.metal`) - the direct sums of every side-chain state's
structure factors over the reflections, one thread per reflection and state; the CPU's sums **to the bit**
(the B factor's exp is `BraggExp.h` on both), which a macOS CI step checks.
- **Molecular-replacement rotation function** (`MolecularReplacementMetal.mm`, `.metal`) - the
rotation function's trial orientations scored from a copy of the molecular transform; equal to the
CPU's to rounding.
@@ -121,5 +121,21 @@ IF (APPLE)
AtomGradientMetal.metal ${CMAKE_CURRENT_BINARY_DIR}/AtomGradientMetalSource.cpp)
SET_SOURCE_FILES_PROPERTIES(AtomGradientMetal.mm PROPERTIES COMPILE_OPTIONS -fobjc-arc)
SET_SOURCE_FILES_PROPERTIES(AtomGradientMetal.metal PROPERTIES HEADER_FILE_ONLY ON)
# The side-chain field's direct sums (SideChainFieldMetal.h), carried in the same way, after the exp the CPU's
# sums take too (bragg_integration/BraggExp.h).
FILE(READ ${CMAKE_CURRENT_SOURCE_DIR}/../bragg_integration/BraggExp.h exp_text)
FILE(READ ${CMAKE_CURRENT_SOURCE_DIR}/SideChainFieldMetal.metal text)
SET_PROPERTY(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/SideChainFieldMetal.metal
${CMAKE_CURRENT_SOURCE_DIR}/../bragg_integration/BraggExp.h)
FILE(WRITE ${CMAKE_CURRENT_BINARY_DIR}/SideChainFieldMetalSource.cpp.tmp
"// Generated from image_analysis/structure_refinement by its CMakeLists.txt - do not edit.\n"
"extern const char *const side_chain_field_metal_source;\n"
"const char *const side_chain_field_metal_source = R\"FIELD_METAL(\n#include <metal_stdlib>\nusing namespace metal;\n#pragma clang fp contract(off)\n${exp_text}\n${text})FIELD_METAL\";\n")
CONFIGURE_FILE(${CMAKE_CURRENT_BINARY_DIR}/SideChainFieldMetalSource.cpp.tmp
${CMAKE_CURRENT_BINARY_DIR}/SideChainFieldMetalSource.cpp COPYONLY)
TARGET_SOURCES(JFJochStructureRefinement PRIVATE SideChainFieldMetal.mm SideChainFieldMetal.h
SideChainFieldMetal.metal ${CMAKE_CURRENT_BINARY_DIR}/SideChainFieldMetalSource.cpp)
SET_SOURCE_FILES_PROPERTIES(SideChainFieldMetal.mm PROPERTIES COMPILE_OPTIONS -fobjc-arc)
SET_SOURCE_FILES_PROPERTIES(SideChainFieldMetal.metal PROPERTIES HEADER_FILE_ONLY ON)
TARGET_LINK_LIBRARIES(JFJochStructureRefinement "-framework Metal" "-framework Foundation")
ENDIF()
@@ -3444,7 +3444,7 @@ RefinementResult RefineOnce(const gemmi::Structure &placed, const std::vector<Me
}
#endif
if (!evaluator)
evaluator = MakeSideChainFieldEvaluatorCPU(fr, FieldOperators(sg), elements, ctx.nthreads);
evaluator = MakeSideChainFieldEvaluatorCPU(fr, FieldOperators(sg), elements, ctx.nthreads, settings.gpu);
std::vector<std::complex<float>> f_total(ctx.fcalc.begin(), ctx.fcalc.begin() + ctx.refl.Size());
evaluator->SetTotal(f_total);
// the copies of each residue, from the NCS anchors (corresponding C-alpha atoms): per residue, numbered
@@ -13,9 +13,16 @@
#include <gemmi/neighbor.hpp>
#include "../../common/ParallelFor.h"
#include "../bragg_integration/BraggExp.h"
#include "RefinementMath.h"
#include "SideChainRotamers.h"
#ifdef __APPLE__
#include "../../common/JFJochException.h"
#include "../../common/Logger.h"
#include "SideChainFieldMetal.h"
#endif
namespace {
constexpr double REPULSION_SIGMA = 0.2; // A, the refinement's (RefinementRestraints.cpp)
@@ -100,7 +107,7 @@ inline void SinCos2Pi(float v, float &sn, float &cs) {
class EvaluatorCPU : public SideChainFieldEvaluator {
public:
EvaluatorCPU(const FieldReflections &refl, const std::vector<std::array<float, 12>> &ops,
const std::vector<FormFactor> &elements, size_t nthreads)
const std::vector<FormFactor> &elements, size_t nthreads, [[maybe_unused]] bool gpu)
: refl_(refl), elements_(elements), nthreads_(nthreads), n_ops_(ops.size()) {
// per operator and row (k * rows + m): R^T h and h . t, so that the phase of an atom at x is
// 2 pi (R^T h . x + h . t)
@@ -126,14 +133,29 @@ public:
f += ff[i] * std::exp(-ff[4 + i] * refl.stol2[m]);
f0_[e * rows + m] = f;
}
#ifdef __APPLE__
if (gpu)
try {
metal_ = SideChainFieldMetal::Make(rows, n_ops_, hx_, hy_, hz_, ht_, f0_, refl.stol2);
} catch (const JFJochException &e) {
MetalFailed(e);
}
#endif
}
void SetTotal(const std::vector<std::complex<float>> &f) override { total_ = f; }
// In single precision, as the GPU's contribution_kernel: per atom of the state its form factor at every row of
// a block, then per operator the phase's sine and cosine (SinCos2Pi) - loops over the rows that the compiler
// vectorises.
// vectorises. The B factor's exp is BraggExp, which an Apple GPU computes to the same bits.
std::vector<std::complex<float>> Contribution(const FieldStates &states, int s) override {
#ifdef __APPLE__
if (metal_) {
std::vector<std::vector<std::complex<float>>> one(1);
if (ContributionsMetal(states, s, one))
return one[0];
}
#endif
const size_t rows = refl_.Size();
std::vector<std::complex<float>> f(rows);
constexpr size_t BLOCK = 256;
@@ -145,7 +167,7 @@ public:
const FieldAtom &at = states.atoms[a];
const float *f0 = &f0_[at.element * rows + lo];
for (size_t m = 0; m < n; m++)
fa[m] = f0[m] * at.occ * std::exp(-at.b * refl_.stol2[lo + m]);
fa[m] = f0[m] * at.occ * BraggExp(-at.b * refl_.stol2[lo + m]);
for (size_t k = 0; k < n_ops_; k++) {
const size_t o = k * rows + lo;
for (size_t m = 0; m < n; m++)
@@ -204,10 +226,39 @@ public:
private:
std::vector<std::vector<std::complex<float>>> All(const FieldStates &states) {
std::vector<std::vector<std::complex<float>>> df;
for (size_t s = 0; s < states.Count(); s++)
#ifdef __APPLE__
// on the GPU in batches of states, so that its buffer stays small beside the states' own
constexpr size_t BATCH = 32;
for (size_t s = 0; metal_ && s < states.Count(); s += BATCH) {
std::vector<std::vector<std::complex<float>>> batch(std::min(BATCH, states.Count() - s));
if (!ContributionsMetal(states, static_cast<int>(s), batch))
break;
for (auto &f : batch)
df.push_back(std::move(f));
}
#endif
for (size_t s = df.size(); s < states.Count(); s++)
df.push_back(Contribution(states, static_cast<int>(s)));
return df;
}
#ifdef __APPLE__
// Contribution() of the states from `first` on, one per element of `out`, on the Apple GPU (SideChainFieldMetal.h):
// the same values, bit for bit. False where it failed: the CPU from then on, with one warning.
bool ContributionsMetal(const FieldStates &states, int first, std::vector<std::vector<std::complex<float>>> &out) {
try {
metal_->Contributions(states, first, out);
return true;
} catch (const JFJochException &e) {
MetalFailed(e);
return false;
}
}
void MetalFailed(const JFJochException &e) {
Logger("Rugnux").Warning("Side-chain field: the Apple GPU failed, on the CPU from here on: {}", e.what());
metal_.reset();
}
std::unique_ptr<SideChainFieldMetal> metal_;
#endif
double Term(size_t m, std::complex<float> f_atoms) const {
const double fc = std::abs(refl_.k_total[m] * (f_atoms + refl_.fmask[m]));
double dfc = 0;
@@ -322,8 +373,8 @@ size_t SideChainFieldDeviceBytes(size_t rows, size_t n_ops) {
std::unique_ptr<SideChainFieldEvaluator> MakeSideChainFieldEvaluatorCPU(const FieldReflections &refl,
const std::vector<std::array<float, 12>> &ops,
const std::vector<FormFactor> &elements,
size_t nthreads) {
return std::make_unique<EvaluatorCPU>(refl, ops, elements, nthreads);
size_t nthreads, bool gpu) {
return std::make_unique<EvaluatorCPU>(refl, ops, elements, nthreads, gpu);
}
std::vector<FieldAtom> FieldAtomsOf(const gemmi::Residue &res, const SideChain &sc, const std::vector<gemmi::Position> &p,
@@ -91,10 +91,12 @@ public:
// The group's operators as the evaluator takes them: rotation (row-major) and translation, fractional.
std::vector<std::array<float, 12>> FieldOperators(const gemmi::SpaceGroup &sg);
// With `gpu`, the direct sums on the Apple GPU where there is one (SideChainFieldMetal.h, macOS): the same values,
// bit for bit.
std::unique_ptr<SideChainFieldEvaluator> MakeSideChainFieldEvaluatorCPU(const FieldReflections &refl,
const std::vector<std::array<float, 12>> &ops,
const std::vector<FormFactor> &elements,
size_t nthreads);
size_t nthreads, bool gpu = false);
#ifdef JFJOCH_USE_CUDA
// The device memory the GPU evaluator takes at most for `rows` reflections under `n_ops` operators, bytes.
size_t SideChainFieldDeviceBytes(size_t rows, size_t n_ops);
@@ -0,0 +1,38 @@
// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#pragma once
// The side-chain field's direct sums (SideChainField.cpp, EvaluatorCPU::Contribution) on an Apple GPU (macOS only):
// one thread per reflection and state, as SideChainFieldGPU.cu's contribution_kernel does under CUDA, with the CPU's
// single-precision arithmetic in its order (SideChainFieldMetal.metal spells it out). tests/SideChainFieldMetalTest.cpp
// holds it to the CPU's.
#include <complex>
#include <cstddef>
#include <memory>
#include <vector>
#include "SideChainField.h" // FieldStates
class SideChainFieldMetal {
public:
// The evaluator's tables, kept on the GPU: per operator and row (k * rows + m) R^T h and h . t, per element and
// row the form factor, per row stol2. Null where there is no Metal device the process may use (rugnux --no-gpu
// hides it). Throws JFJochException on a Metal failure.
static std::unique_ptr<SideChainFieldMetal> Make(size_t rows, size_t n_ops, const std::vector<float> &hx,
const std::vector<float> &hy, const std::vector<float> &hz,
const std::vector<float> &ht, const std::vector<float> &f0,
const std::vector<float> &stol2);
~SideChainFieldMetal();
// The contributions of states first .. first + out.size() - 1, each `rows` values into its vector.
void Contributions(const FieldStates &states, int first, std::vector<std::vector<std::complex<float>>> &out);
// How many states the GPU has summed in this process.
static size_t States();
struct Impl;
private:
explicit SideChainFieldMetal(std::unique_ptr<Impl> impl);
std::unique_ptr<Impl> impl_;
};
@@ -0,0 +1,58 @@
// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
// The side-chain field's direct sums (SideChainFieldMetal.h), compiled when first used from this source, which
// CMakeLists.txt copies into the binary after bragg_integration/BraggExp.h - with fast math off and no a*b+c
// contracted, as on the host, so that every operation below rounds as EvaluatorCPU::Contribution's does.
#include <metal_stdlib>
using namespace metal;
#pragma clang fp contract(off)
struct Atom { // FieldAtom
float x, y, z, b, occ;
int element;
};
struct Params {
uint rows, n_ops, first;
};
// SideChainField.cpp's SinCos2Pi(): sin and cos of 2 pi v, v taken to [-1/2, 1/2] by its nearest integer, the half
// angle by its Taylor series, then the double-angle formulas.
static void sincos_2pi(float v, thread float &sn, thread float &cs) {
const float x = 3.14159265f * (v - rint(v));
const float x2 = x * x;
const float s = x * (1 + x2 * (-1.f / 6 + x2 * (1.f / 120 + x2 * (-1.f / 5040 + x2 * (1.f / 362880 + x2 * (-1.f / 39916800))))));
const float c = 1 + x2 * (-1.f / 2 + x2 * (1.f / 24 + x2 * (-1.f / 720 + x2 * (1.f / 40320 + x2 * (-1.f / 3628800 + x2 * (1.f / 479001600))))));
sn = 2 * s * c;
cs = c * c - s * s;
}
// One thread per row m and state first + s: the state's atoms in order, each over the operators in order.
kernel void contribution(device const float *hx [[buffer(0)]], device const float *hy [[buffer(1)]],
device const float *hz [[buffer(2)]], device const float *ht [[buffer(3)]],
device const float *f0 [[buffer(4)]], device const float *stol2 [[buffer(5)]],
device const Atom *atoms [[buffer(6)]], device const int *start [[buffer(7)]],
constant Params &p [[buffer(8)]], device float2 *out [[buffer(9)]],
uint2 gid [[thread_position_in_grid]]) {
const uint m = gid.x, s = gid.y;
if (m >= p.rows)
return;
const float st = stol2[m];
float re = 0, im = 0;
for (int a = start[p.first + s]; a < start[p.first + s + 1]; a++) {
const Atom at = atoms[a];
const float fa = f0[uint(at.element) * p.rows + m] * at.occ * BraggExp(-at.b * st);
for (uint k = 0; k < p.n_ops; k++) {
const uint o = k * p.rows + m;
const float v = hx[o] * at.x + hy[o] * at.y + hz[o] * at.z + ht[o];
float sn, cs;
sincos_2pi(v, sn, cs);
re += fa * cs;
im += fa * sn;
}
}
out[s * p.rows + m] = float2(re, im);
}
@@ -0,0 +1,156 @@
// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#import <Metal/Metal.h>
#include "SideChainFieldMetal.h"
#include <algorithm>
#include <atomic>
#include <cstdint>
#include <cstring>
#include <limits>
#include <string>
#include "../../common/CUDAWrapper.h" // gpus_are_hidden
#include "../../common/JFJochException.h"
// The kernel's source, SideChainFieldMetal.metal, copied in at configure time (CMakeLists.txt).
extern const char *const side_chain_field_metal_source;
namespace {
std::atomic<size_t> states_on_gpu{0};
static_assert(sizeof(FieldAtom) == 6 * 4, "the kernel's Atom is six words");
struct Kernel {
id<MTLDevice> device = nil; // nil: no Metal device
id<MTLComputePipelineState> pipeline = nil;
id<MTLCommandQueue> queue = nil;
};
// Compiled once per process, the first time it is asked for.
const Kernel &GetKernel() {
static const Kernel kernel = [] {
Kernel k;
k.device = MTLCreateSystemDefaultDevice();
if (k.device == nil)
return k;
MTLCompileOptions *options = [MTLCompileOptions new];
// Fast math off: nothing reassociated or approximated, as on the CPU.
options.fastMathEnabled = NO;
options.languageVersion = MTLLanguageVersion3_0;
NSError *error = nil;
id<MTLLibrary> library = [k.device newLibraryWithSource:@(side_chain_field_metal_source) options:options
error:&error];
if (library == nil)
throw JFJochException(JFJochExceptionCategory::GPUMetalError,
std::string("side-chain field kernel: ") + error.localizedDescription.UTF8String);
id<MTLFunction> function = [library newFunctionWithName:@"contribution"];
k.pipeline = [k.device newComputePipelineStateWithFunction:function error:&error];
if (k.pipeline == nil)
throw JFJochException(JFJochExceptionCategory::GPUMetalError,
std::string("contribution: ") + error.localizedDescription.UTF8String);
k.queue = [k.device newCommandQueue];
return k;
}();
return kernel;
}
id<MTLBuffer> NewBuffer(id<MTLDevice> device, size_t bytes) {
id<MTLBuffer> b = [device newBufferWithLength:std::max<size_t>(bytes, 4) options:MTLResourceStorageModeShared];
if (b == nil)
throw JFJochException(JFJochExceptionCategory::GPUMetalError, "side-chain field: out of GPU memory");
return b;
}
id<MTLBuffer> Upload(id<MTLDevice> device, const std::vector<float> &v) {
id<MTLBuffer> b = NewBuffer(device, v.size() * sizeof(float));
std::memcpy(b.contents, v.data(), v.size() * sizeof(float));
return b;
}
struct Params {
uint32_t rows, n_ops, first;
};
} // namespace
struct SideChainFieldMetal::Impl {
uint32_t rows, n_ops;
id<MTLBuffer> hx, hy, hz, ht, f0, stol2;
};
SideChainFieldMetal::SideChainFieldMetal(std::unique_ptr<Impl> impl) : impl_(std::move(impl)) {}
SideChainFieldMetal::~SideChainFieldMetal() = default;
std::unique_ptr<SideChainFieldMetal> SideChainFieldMetal::Make(size_t rows, size_t n_ops, const std::vector<float> &hx,
const std::vector<float> &hy,
const std::vector<float> &hz,
const std::vector<float> &ht,
const std::vector<float> &f0,
const std::vector<float> &stol2) {
@autoreleasepool {
if (gpus_are_hidden() || rows * std::max<size_t>(n_ops, 1) > std::numeric_limits<uint32_t>::max())
return nullptr;
const Kernel &k = GetKernel();
if (k.device == nil)
return nullptr;
auto impl = std::make_unique<Impl>();
impl->rows = static_cast<uint32_t>(rows);
impl->n_ops = static_cast<uint32_t>(n_ops);
impl->hx = Upload(k.device, hx);
impl->hy = Upload(k.device, hy);
impl->hz = Upload(k.device, hz);
impl->ht = Upload(k.device, ht);
impl->f0 = Upload(k.device, f0);
impl->stol2 = Upload(k.device, stol2);
return std::unique_ptr<SideChainFieldMetal>(new SideChainFieldMetal(std::move(impl)));
}
}
void SideChainFieldMetal::Contributions(const FieldStates &states, int first,
std::vector<std::vector<std::complex<float>>> &out) {
// In a pool of its own, as ModelDensityMetal(): the threads this runs on have none.
@autoreleasepool {
const Kernel &k = GetKernel();
const size_t rows = impl_->rows, count = out.size();
if (count == 0)
return;
id<MTLBuffer> d_atoms = NewBuffer(k.device, states.atoms.size() * sizeof(FieldAtom));
std::memcpy(d_atoms.contents, states.atoms.data(), states.atoms.size() * sizeof(FieldAtom));
id<MTLBuffer> d_start = NewBuffer(k.device, states.start.size() * sizeof(int));
std::memcpy(d_start.contents, states.start.data(), states.start.size() * sizeof(int));
id<MTLBuffer> d_out = NewBuffer(k.device, count * rows * sizeof(std::complex<float>));
const Params p{impl_->rows, impl_->n_ops, static_cast<uint32_t>(first)};
id<MTLCommandBuffer> cb = [k.queue commandBuffer];
id<MTLComputeCommandEncoder> e = [cb computeCommandEncoder];
[e setComputePipelineState:k.pipeline];
id<MTLBuffer> tables[] = {impl_->hx, impl_->hy, impl_->hz, impl_->ht, impl_->f0, impl_->stol2};
for (int i = 0; i < 6; i++)
[e setBuffer:tables[i] offset:0 atIndex:i];
[e setBuffer:d_atoms offset:0 atIndex:6];
[e setBuffer:d_start offset:0 atIndex:7];
[e setBytes:&p length:sizeof(p) atIndex:8];
[e setBuffer:d_out offset:0 atIndex:9];
[e dispatchThreads:MTLSizeMake(rows, count, 1) threadsPerThreadgroup:MTLSizeMake(256, 1, 1)];
[e endEncoding];
[cb commit];
[cb waitUntilCompleted];
if (cb.status != MTLCommandBufferStatusCompleted)
throw JFJochException(JFJochExceptionCategory::GPUMetalError,
cb.error ? cb.error.localizedDescription.UTF8String
: "side-chain field: command buffer failed");
const auto *f = static_cast<const std::complex<float> *>(d_out.contents);
for (size_t s = 0; s < count; s++)
out[s].assign(f + s * rows, f + (s + 1) * rows);
states_on_gpu += count;
}
}
size_t SideChainFieldMetal::States() {
return states_on_gpu;
}
+1
View File
@@ -36,6 +36,7 @@ ADD_EXECUTABLE(jfjoch_portable_test EXCLUDE_FROM_ALL
MolecularReplacementMetalTest.cpp
ModelDensityMetalTest.cpp
AtomGradientMetalTest.cpp
SideChainFieldMetalTest.cpp
WriteReflectionsTest.cpp
LoadReferenceMtzFreeFlagsTest.cpp
LoadReferenceSfCifTest.cpp
+77
View File
@@ -0,0 +1,77 @@
// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#include <catch2/catch_all.hpp>
#ifdef __APPLE__
#include <complex>
#include <cstring>
#include <random>
#include <vector>
#include "gemmi/it92.hpp"
#include "gemmi/symmetry.hpp"
#include "../image_analysis/structure_refinement/SideChainField.h"
#include "../image_analysis/structure_refinement/SideChainFieldMetal.h"
// The side-chain field's direct sums on the Apple GPU (SideChainFieldMetal.h) are the CPU's, bit for bit, so the
// contributions are compared as bit patterns and the energies exactly. A Mac without a Metal device fails rather than
// skips, as in ModelDensityMetalTest.cpp.
TEST_CASE("SideChainFieldMetal_BitIdenticalToCPU", "[portable][Metal]") {
std::mt19937 rng(23);
std::uniform_real_distribution<float> unit(0.0f, 1.0f);
std::uniform_int_distribution<int> index(-25, 25);
// reflections of a 50 A cell to about 2 A, in no particular order, a tenth of them free
FieldReflections fr;
for (int i = 0; i < 20000; i++) {
const float h = static_cast<float>(index(rng)), k = static_cast<float>(index(rng)), l = static_cast<float>(index(rng));
fr.hkl.push_back({h, k, l});
fr.stol2.push_back((h * h + k * k + l * l) / (4.0f * 50 * 50));
fr.fo.push_back(100 * unit(rng));
fr.d.push_back(0.9f);
fr.var.push_back(50 + 100 * unit(rng));
fr.centric.push_back(i % 7 == 0);
fr.work.push_back(i % 10 != 0);
fr.k_total.push_back(1.0f);
fr.fmask.push_back({10 * unit(rng), 10 * unit(rng)});
}
const std::vector<FormFactor> elements = {gemmi::IT92<float>::get(gemmi::El::C, 0).coefs,
gemmi::IT92<float>::get(gemmi::El::N, 0).coefs,
gemmi::IT92<float>::get(gemmi::El::O, 0).coefs};
const auto ops = FieldOperators(*gemmi::find_spacegroup_by_name("P 21 21 21"));
// 70 states of six atoms each - more than one batch - and combinations of one and of two states
FieldStates states;
for (int s = 0; s < 70; s++) {
std::vector<FieldAtom> atoms;
for (int a = 0; a < 6; a++)
atoms.push_back({unit(rng), unit(rng), unit(rng), 10 + 50 * unit(rng), 0.5f + 0.5f * unit(rng), a % 3});
states.Add(atoms);
}
states.current = {0};
for (int c = 0; c < 69; c++)
states.AddCombo(c % 2 == 0 ? std::vector<int>{c} : std::vector<int>{c, c + 1});
auto cpu = MakeSideChainFieldEvaluatorCPU(fr, ops, elements, 4, false);
auto gpu = MakeSideChainFieldEvaluatorCPU(fr, ops, elements, 4, true);
const size_t before = SideChainFieldMetal::States();
size_t different = 0;
for (int s : {0, 33, 69}) {
const std::vector<std::complex<float>> c = cpu->Contribution(states, s), g = gpu->Contribution(states, s);
REQUIRE(c.size() == g.size());
for (size_t m = 0; m < c.size(); m++)
different += std::memcmp(&c[m], &g[m], sizeof(c[m])) != 0;
}
REQUIRE(SideChainFieldMetal::States() == before + 3); // the GPU summed them
CHECK(different == 0);
const std::vector<std::complex<float>> total = cpu->Contribution(states, 0);
cpu->SetTotal(total);
gpu->SetTotal(total);
const std::vector<double> ec = cpu->Evaluate(states), eg = gpu->Evaluate(states);
REQUIRE(SideChainFieldMetal::States() == before + 3 + 70);
CHECK(ec == eg);
}
#endif