xref: /petsc/src/mat/impls/transpose/htransm.c (revision f5bab676488eab7ccb90dc895dfba268b72c04e0)
1a1f56445SPierre Jolivet #include <../src/mat/impls/shell/shell.h> /*I "petscmat.h" I*/
2d0de2241SAndrew Spott 
3bf477422SJose E. Roman PETSC_INTERN PetscErrorCode MatProductSetFromOptions_HT(Mat D)
4d71ae5a4SJacob Faibussowitsch {
5013e2dc7SBarry Smith   Mat            A, B, C, Ain, Bin, Cin;
6013e2dc7SBarry Smith   PetscBool      Aistrans, Bistrans, Cistrans;
7013e2dc7SBarry Smith   PetscInt       Atrans, Btrans, Ctrans;
8013e2dc7SBarry Smith   MatProductType ptype;
9013e2dc7SBarry Smith 
10013e2dc7SBarry Smith   PetscFunctionBegin;
11013e2dc7SBarry Smith   MatCheckProduct(D, 1);
12013e2dc7SBarry Smith   A = D->product->A;
13013e2dc7SBarry Smith   B = D->product->B;
14013e2dc7SBarry Smith   C = D->product->C;
15013e2dc7SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATHERMITIANTRANSPOSEVIRTUAL, &Aistrans));
16013e2dc7SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)B, MATHERMITIANTRANSPOSEVIRTUAL, &Bistrans));
17013e2dc7SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)C, MATHERMITIANTRANSPOSEVIRTUAL, &Cistrans));
18013e2dc7SBarry Smith   PetscCheck(Aistrans || Bistrans || Cistrans, PetscObjectComm((PetscObject)D), PETSC_ERR_PLIB, "This should not happen");
19013e2dc7SBarry Smith   Atrans = 0;
20013e2dc7SBarry Smith   Ain    = A;
21013e2dc7SBarry Smith   while (Aistrans) {
22013e2dc7SBarry Smith     Atrans++;
23013e2dc7SBarry Smith     PetscCall(MatHermitianTransposeGetMat(Ain, &Ain));
24013e2dc7SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)Ain, MATHERMITIANTRANSPOSEVIRTUAL, &Aistrans));
25013e2dc7SBarry Smith   }
26013e2dc7SBarry Smith   Btrans = 0;
27013e2dc7SBarry Smith   Bin    = B;
28013e2dc7SBarry Smith   while (Bistrans) {
29013e2dc7SBarry Smith     Btrans++;
30013e2dc7SBarry Smith     PetscCall(MatHermitianTransposeGetMat(Bin, &Bin));
31013e2dc7SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)Bin, MATHERMITIANTRANSPOSEVIRTUAL, &Bistrans));
32013e2dc7SBarry Smith   }
33013e2dc7SBarry Smith   Ctrans = 0;
34013e2dc7SBarry Smith   Cin    = C;
35013e2dc7SBarry Smith   while (Cistrans) {
36013e2dc7SBarry Smith     Ctrans++;
37013e2dc7SBarry Smith     PetscCall(MatHermitianTransposeGetMat(Cin, &Cin));
38013e2dc7SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)Cin, MATHERMITIANTRANSPOSEVIRTUAL, &Cistrans));
39013e2dc7SBarry Smith   }
40013e2dc7SBarry Smith   Atrans = Atrans % 2;
41013e2dc7SBarry Smith   Btrans = Btrans % 2;
42013e2dc7SBarry Smith   Ctrans = Ctrans % 2;
43013e2dc7SBarry Smith   ptype  = D->product->type; /* same product type by default */
44013e2dc7SBarry Smith   if (Ain->symmetric == PETSC_BOOL3_TRUE) Atrans = 0;
45013e2dc7SBarry Smith   if (Bin->symmetric == PETSC_BOOL3_TRUE) Btrans = 0;
46013e2dc7SBarry Smith   if (Cin && Cin->symmetric == PETSC_BOOL3_TRUE) Ctrans = 0;
47013e2dc7SBarry Smith 
48013e2dc7SBarry Smith   if (Atrans || Btrans || Ctrans) {
495afd5614SVaclav Hapla     PetscCheck(!PetscDefined(USE_COMPLEX), PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "No support for complex Hermitian transpose matrices");
50013e2dc7SBarry Smith     ptype = MATPRODUCT_UNSPECIFIED;
51013e2dc7SBarry Smith     switch (D->product->type) {
52013e2dc7SBarry Smith     case MATPRODUCT_AB:
53013e2dc7SBarry Smith       if (Atrans && Btrans) { /* At * Bt we do not have support for this */
54013e2dc7SBarry Smith         /* TODO custom implementation ? */
55013e2dc7SBarry Smith       } else if (Atrans) { /* At * B */
56013e2dc7SBarry Smith         ptype = MATPRODUCT_AtB;
57013e2dc7SBarry Smith       } else { /* A * Bt */
58013e2dc7SBarry Smith         ptype = MATPRODUCT_ABt;
59013e2dc7SBarry Smith       }
60013e2dc7SBarry Smith       break;
61013e2dc7SBarry Smith     case MATPRODUCT_AtB:
62013e2dc7SBarry Smith       if (Atrans && Btrans) { /* A * Bt */
63013e2dc7SBarry Smith         ptype = MATPRODUCT_ABt;
64013e2dc7SBarry Smith       } else if (Atrans) { /* A * B */
65013e2dc7SBarry Smith         ptype = MATPRODUCT_AB;
66013e2dc7SBarry Smith       } else { /* At * Bt we do not have support for this */
67013e2dc7SBarry Smith         /* TODO custom implementation ? */
68013e2dc7SBarry Smith       }
69013e2dc7SBarry Smith       break;
70013e2dc7SBarry Smith     case MATPRODUCT_ABt:
71013e2dc7SBarry Smith       if (Atrans && Btrans) { /* At * B */
72013e2dc7SBarry Smith         ptype = MATPRODUCT_AtB;
73013e2dc7SBarry Smith       } else if (Atrans) { /* At * Bt we do not have support for this */
74013e2dc7SBarry Smith         /* TODO custom implementation ? */
75013e2dc7SBarry Smith       } else { /* A * B */
76013e2dc7SBarry Smith         ptype = MATPRODUCT_AB;
77013e2dc7SBarry Smith       }
78013e2dc7SBarry Smith       break;
79013e2dc7SBarry Smith     case MATPRODUCT_PtAP:
80013e2dc7SBarry Smith       if (Atrans) { /* PtAtP */
81013e2dc7SBarry Smith         /* TODO custom implementation ? */
82013e2dc7SBarry Smith       } else { /* RARt */
83013e2dc7SBarry Smith         ptype = MATPRODUCT_RARt;
84013e2dc7SBarry Smith       }
85013e2dc7SBarry Smith       break;
86013e2dc7SBarry Smith     case MATPRODUCT_RARt:
87013e2dc7SBarry Smith       if (Atrans) { /* RAtRt */
88013e2dc7SBarry Smith         /* TODO custom implementation ? */
89013e2dc7SBarry Smith       } else { /* PtAP */
90013e2dc7SBarry Smith         ptype = MATPRODUCT_PtAP;
91013e2dc7SBarry Smith       }
92013e2dc7SBarry Smith       break;
93013e2dc7SBarry Smith     case MATPRODUCT_ABC:
94013e2dc7SBarry Smith       /* TODO custom implementation ? */
95013e2dc7SBarry Smith       break;
96d71ae5a4SJacob Faibussowitsch     default:
97d71ae5a4SJacob Faibussowitsch       SETERRQ(PetscObjectComm((PetscObject)D), PETSC_ERR_SUP, "ProductType %s is not supported", MatProductTypes[D->product->type]);
98013e2dc7SBarry Smith     }
99013e2dc7SBarry Smith   }
100013e2dc7SBarry Smith   PetscCall(MatProductReplaceMats(Ain, Bin, Cin, D));
101013e2dc7SBarry Smith   PetscCall(MatProductSetType(D, ptype));
102013e2dc7SBarry Smith   PetscCall(MatProductSetFromOptions(D));
1033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
104013e2dc7SBarry Smith }
105f1769f9dSJose E. Roman 
10666976f2fSJacob Faibussowitsch static PetscErrorCode MatMult_HT(Mat N, Vec x, Vec y)
107d71ae5a4SJacob Faibussowitsch {
108bf477422SJose E. Roman   Mat A;
109d0de2241SAndrew Spott 
110d0de2241SAndrew Spott   PetscFunctionBegin;
111bf477422SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
112bf477422SJose E. Roman   PetscCall(MatMultHermitianTranspose(A, x, y));
1133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
114d0de2241SAndrew Spott }
115d0de2241SAndrew Spott 
11666976f2fSJacob Faibussowitsch static PetscErrorCode MatMultHermitianTranspose_HT(Mat N, Vec x, Vec y)
117d71ae5a4SJacob Faibussowitsch {
118bf477422SJose E. Roman   Mat A;
119d0de2241SAndrew Spott 
120d0de2241SAndrew Spott   PetscFunctionBegin;
121bf477422SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
122bf477422SJose E. Roman   PetscCall(MatMult(A, x, y));
1233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
124d0de2241SAndrew Spott }
125f1769f9dSJose E. Roman 
126f1769f9dSJose E. Roman static PetscErrorCode MatSolve_HT_LU(Mat N, Vec b, Vec x)
127f1769f9dSJose E. Roman {
128f1769f9dSJose E. Roman   Mat A;
129f1769f9dSJose E. Roman   Vec w;
130f1769f9dSJose E. Roman 
131f1769f9dSJose E. Roman   PetscFunctionBegin;
132f1769f9dSJose E. Roman   PetscCall(MatShellGetContext(N, &A));
133f1769f9dSJose E. Roman   PetscCall(VecDuplicate(b, &w));
134f1769f9dSJose E. Roman   PetscCall(VecCopy(b, w));
135f1769f9dSJose E. Roman   PetscCall(VecConjugate(w));
136f1769f9dSJose E. Roman   PetscCall(MatSolveTranspose(A, w, x));
137f1769f9dSJose E. Roman   PetscCall(VecConjugate(x));
138f1769f9dSJose E. Roman   PetscCall(VecDestroy(&w));
139f1769f9dSJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
140f1769f9dSJose E. Roman }
141f1769f9dSJose E. Roman 
142f1769f9dSJose E. Roman static PetscErrorCode MatSolveAdd_HT_LU(Mat N, Vec b, Vec y, Vec x)
143f1769f9dSJose E. Roman {
144f1769f9dSJose E. Roman   Mat A;
145f1769f9dSJose E. Roman   Vec v, w;
146f1769f9dSJose E. Roman 
147f1769f9dSJose E. Roman   PetscFunctionBegin;
148f1769f9dSJose E. Roman   PetscCall(MatShellGetContext(N, &A));
149f1769f9dSJose E. Roman   PetscCall(VecDuplicate(b, &v));
150f1769f9dSJose E. Roman   PetscCall(VecDuplicate(b, &w));
151f1769f9dSJose E. Roman   PetscCall(VecCopy(y, v));
152f1769f9dSJose E. Roman   PetscCall(VecCopy(b, w));
153f1769f9dSJose E. Roman   PetscCall(VecConjugate(v));
154f1769f9dSJose E. Roman   PetscCall(VecConjugate(w));
155f1769f9dSJose E. Roman   PetscCall(MatSolveTransposeAdd(A, w, v, x));
156f1769f9dSJose E. Roman   PetscCall(VecConjugate(x));
157f1769f9dSJose E. Roman   PetscCall(VecDestroy(&v));
158f1769f9dSJose E. Roman   PetscCall(VecDestroy(&w));
159f1769f9dSJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
160f1769f9dSJose E. Roman }
161f1769f9dSJose E. Roman 
162f1769f9dSJose E. Roman static PetscErrorCode MatMatSolve_HT_LU(Mat N, Mat B, Mat X)
163f1769f9dSJose E. Roman {
164f1769f9dSJose E. Roman   Mat A, W;
165f1769f9dSJose E. Roman 
166f1769f9dSJose E. Roman   PetscFunctionBegin;
167f1769f9dSJose E. Roman   PetscCall(MatShellGetContext(N, &A));
168f1769f9dSJose E. Roman   PetscCall(MatDuplicate(B, MAT_COPY_VALUES, &W));
169f1769f9dSJose E. Roman   PetscCall(MatConjugate(W));
170f1769f9dSJose E. Roman   PetscCall(MatMatSolveTranspose(A, W, X));
171f1769f9dSJose E. Roman   PetscCall(MatConjugate(X));
172f1769f9dSJose E. Roman   PetscCall(MatDestroy(&W));
173f1769f9dSJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
174f1769f9dSJose E. Roman }
175f1769f9dSJose E. Roman 
176f1769f9dSJose E. Roman static PetscErrorCode MatLUFactor_HT(Mat N, IS row, IS col, const MatFactorInfo *minfo)
177f1769f9dSJose E. Roman {
178f1769f9dSJose E. Roman   Mat A;
179f1769f9dSJose E. Roman 
180f1769f9dSJose E. Roman   PetscFunctionBegin;
181f1769f9dSJose E. Roman   PetscCall(MatShellGetContext(N, &A));
182f1769f9dSJose E. Roman   PetscCall(MatLUFactor(A, col, row, minfo));
183f1769f9dSJose E. Roman   PetscCall(MatShellSetOperation(N, MATOP_SOLVE, (void (*)(void))MatSolve_HT_LU));
184f1769f9dSJose E. Roman   PetscCall(MatShellSetOperation(N, MATOP_SOLVE_ADD, (void (*)(void))MatSolveAdd_HT_LU));
185f1769f9dSJose E. Roman   PetscCall(MatShellSetOperation(N, MATOP_MAT_SOLVE, (void (*)(void))MatMatSolve_HT_LU));
186f1769f9dSJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
187f1769f9dSJose E. Roman }
188f1769f9dSJose E. Roman 
189f1769f9dSJose E. Roman static PetscErrorCode MatSolve_HT_Cholesky(Mat N, Vec b, Vec x)
190f1769f9dSJose E. Roman {
191f1769f9dSJose E. Roman   Mat A;
192f1769f9dSJose E. Roman 
193f1769f9dSJose E. Roman   PetscFunctionBegin;
194f1769f9dSJose E. Roman   PetscCall(MatShellGetContext(N, &A));
195f1769f9dSJose E. Roman   PetscCall(MatSolve(A, b, x));
196f1769f9dSJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
197f1769f9dSJose E. Roman }
198f1769f9dSJose E. Roman 
199f1769f9dSJose E. Roman static PetscErrorCode MatSolveAdd_HT_Cholesky(Mat N, Vec b, Vec y, Vec x)
200f1769f9dSJose E. Roman {
201f1769f9dSJose E. Roman   Mat A;
202f1769f9dSJose E. Roman   Vec v, w;
203f1769f9dSJose E. Roman 
204f1769f9dSJose E. Roman   PetscFunctionBegin;
205f1769f9dSJose E. Roman   PetscCall(MatShellGetContext(N, &A));
206f1769f9dSJose E. Roman   PetscCall(VecDuplicate(b, &v));
207f1769f9dSJose E. Roman   PetscCall(VecDuplicate(b, &w));
208f1769f9dSJose E. Roman   PetscCall(VecCopy(y, v));
209f1769f9dSJose E. Roman   PetscCall(VecCopy(b, w));
210f1769f9dSJose E. Roman   PetscCall(VecConjugate(v));
211f1769f9dSJose E. Roman   PetscCall(VecConjugate(w));
212f1769f9dSJose E. Roman   PetscCall(MatSolveTransposeAdd(A, w, v, x));
213f1769f9dSJose E. Roman   PetscCall(VecConjugate(x));
214f1769f9dSJose E. Roman   PetscCall(VecDestroy(&v));
215f1769f9dSJose E. Roman   PetscCall(VecDestroy(&w));
216f1769f9dSJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
217f1769f9dSJose E. Roman }
218f1769f9dSJose E. Roman 
219f1769f9dSJose E. Roman static PetscErrorCode MatMatSolve_HT_Cholesky(Mat N, Mat B, Mat X)
220f1769f9dSJose E. Roman {
221f1769f9dSJose E. Roman   Mat A, W;
222f1769f9dSJose E. Roman 
223f1769f9dSJose E. Roman   PetscFunctionBegin;
224f1769f9dSJose E. Roman   PetscCall(MatShellGetContext(N, &A));
225f1769f9dSJose E. Roman   PetscCall(MatDuplicate(B, MAT_COPY_VALUES, &W));
226f1769f9dSJose E. Roman   PetscCall(MatConjugate(W));
227f1769f9dSJose E. Roman   PetscCall(MatMatSolveTranspose(A, W, X));
228f1769f9dSJose E. Roman   PetscCall(MatConjugate(X));
229f1769f9dSJose E. Roman   PetscCall(MatDestroy(&W));
230f1769f9dSJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
231f1769f9dSJose E. Roman }
232f1769f9dSJose E. Roman 
233f1769f9dSJose E. Roman static PetscErrorCode MatCholeskyFactor_HT(Mat N, IS perm, const MatFactorInfo *minfo)
234f1769f9dSJose E. Roman {
235f1769f9dSJose E. Roman   Mat A;
236f1769f9dSJose E. Roman 
237f1769f9dSJose E. Roman   PetscFunctionBegin;
238f1769f9dSJose E. Roman   PetscCall(MatShellGetContext(N, &A));
239f1769f9dSJose E. Roman   PetscCheck(!PetscDefined(USE_COMPLEX) || A->hermitian == PETSC_BOOL3_TRUE, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Cholesky supported only if original matrix is Hermitian");
240f1769f9dSJose E. Roman   PetscCall(MatCholeskyFactor(A, perm, minfo));
241f1769f9dSJose E. Roman   PetscCall(MatShellSetOperation(N, MATOP_SOLVE, (void (*)(void))MatSolve_HT_Cholesky));
242f1769f9dSJose E. Roman   PetscCall(MatShellSetOperation(N, MATOP_SOLVE_ADD, (void (*)(void))MatSolveAdd_HT_Cholesky));
243f1769f9dSJose E. Roman   PetscCall(MatShellSetOperation(N, MATOP_MAT_SOLVE, (void (*)(void))MatMatSolve_HT_Cholesky));
244f1769f9dSJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
245f1769f9dSJose E. Roman }
246f1769f9dSJose E. Roman 
247*f5bab676SJose E. Roman static PetscErrorCode MatLUFactorNumeric_HT(Mat F, Mat N, const MatFactorInfo *info)
248*f5bab676SJose E. Roman {
249*f5bab676SJose E. Roman   Mat A, FA;
250*f5bab676SJose E. Roman 
251*f5bab676SJose E. Roman   PetscFunctionBegin;
252*f5bab676SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
253*f5bab676SJose E. Roman   PetscCall(MatShellGetContext(F, &FA));
254*f5bab676SJose E. Roman   PetscCall(MatLUFactorNumeric(FA, A, info));
255*f5bab676SJose E. Roman   PetscCall(MatShellSetOperation(F, MATOP_SOLVE, (void (*)(void))MatSolve_HT_LU));
256*f5bab676SJose E. Roman   PetscCall(MatShellSetOperation(F, MATOP_SOLVE_ADD, (void (*)(void))MatSolveAdd_HT_LU));
257*f5bab676SJose E. Roman   PetscCall(MatShellSetOperation(F, MATOP_MAT_SOLVE, (void (*)(void))MatMatSolve_HT_LU));
258*f5bab676SJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
259*f5bab676SJose E. Roman }
260*f5bab676SJose E. Roman 
261*f5bab676SJose E. Roman static PetscErrorCode MatLUFactorSymbolic_HT(Mat F, Mat N, IS row, IS col, const MatFactorInfo *info)
262*f5bab676SJose E. Roman {
263*f5bab676SJose E. Roman   Mat A, FA;
264*f5bab676SJose E. Roman 
265*f5bab676SJose E. Roman   PetscFunctionBegin;
266*f5bab676SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
267*f5bab676SJose E. Roman   PetscCall(MatShellGetContext(F, &FA));
268*f5bab676SJose E. Roman   PetscCall(MatLUFactorSymbolic(FA, A, row, col, info));
269*f5bab676SJose E. Roman   PetscCall(MatShellSetOperation(F, MATOP_LUFACTOR_NUMERIC, (void (*)(void))MatLUFactorNumeric_HT));
270*f5bab676SJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
271*f5bab676SJose E. Roman }
272*f5bab676SJose E. Roman 
273*f5bab676SJose E. Roman static PetscErrorCode MatCholeskyFactorNumeric_HT(Mat F, Mat N, const MatFactorInfo *info)
274*f5bab676SJose E. Roman {
275*f5bab676SJose E. Roman   Mat A, FA;
276*f5bab676SJose E. Roman 
277*f5bab676SJose E. Roman   PetscFunctionBegin;
278*f5bab676SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
279*f5bab676SJose E. Roman   PetscCall(MatShellGetContext(F, &FA));
280*f5bab676SJose E. Roman   PetscCall(MatCholeskyFactorNumeric(FA, A, info));
281*f5bab676SJose E. Roman   PetscCall(MatShellSetOperation(F, MATOP_SOLVE, (void (*)(void))MatSolve_HT_Cholesky));
282*f5bab676SJose E. Roman   PetscCall(MatShellSetOperation(F, MATOP_SOLVE_ADD, (void (*)(void))MatSolveAdd_HT_Cholesky));
283*f5bab676SJose E. Roman   PetscCall(MatShellSetOperation(F, MATOP_MAT_SOLVE, (void (*)(void))MatMatSolve_HT_Cholesky));
284*f5bab676SJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
285*f5bab676SJose E. Roman }
286*f5bab676SJose E. Roman 
287*f5bab676SJose E. Roman static PetscErrorCode MatCholeskyFactorSymbolic_HT(Mat F, Mat N, IS perm, const MatFactorInfo *info)
288*f5bab676SJose E. Roman {
289*f5bab676SJose E. Roman   Mat A, FA;
290*f5bab676SJose E. Roman 
291*f5bab676SJose E. Roman   PetscFunctionBegin;
292*f5bab676SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
293*f5bab676SJose E. Roman   PetscCall(MatShellGetContext(F, &FA));
294*f5bab676SJose E. Roman   PetscCall(MatCholeskyFactorSymbolic(FA, A, perm, info));
295*f5bab676SJose E. Roman   PetscCall(MatShellSetOperation(F, MATOP_CHOLESKY_FACTOR_NUMERIC, (void (*)(void))MatCholeskyFactorNumeric_HT));
296*f5bab676SJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
297*f5bab676SJose E. Roman }
298*f5bab676SJose E. Roman 
299*f5bab676SJose E. Roman static PetscErrorCode MatGetFactor_HT(Mat N, MatSolverType type, MatFactorType ftype, Mat *F)
300*f5bab676SJose E. Roman {
301*f5bab676SJose E. Roman   Mat A, FA;
302*f5bab676SJose E. Roman 
303*f5bab676SJose E. Roman   PetscFunctionBegin;
304*f5bab676SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
305*f5bab676SJose E. Roman   PetscCall(MatGetFactor(A, type, ftype, &FA));
306*f5bab676SJose E. Roman   PetscCall(MatCreateTranspose(FA, F));
307*f5bab676SJose E. Roman   if (ftype == MAT_FACTOR_LU) PetscCall(MatShellSetOperation(*F, MATOP_LUFACTOR_SYMBOLIC, (void (*)(void))MatLUFactorSymbolic_HT));
308*f5bab676SJose E. Roman   else if (ftype == MAT_FACTOR_CHOLESKY) {
309*f5bab676SJose E. Roman     PetscCheck(!PetscDefined(USE_COMPLEX) || A->hermitian == PETSC_BOOL3_TRUE, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Cholesky supported only if original matrix is Hermitian");
310*f5bab676SJose E. Roman     PetscCall(MatPropagateSymmetryOptions(A, FA));
311*f5bab676SJose E. Roman     PetscCall(MatShellSetOperation(*F, MATOP_CHOLESKY_FACTOR_SYMBOLIC, (void (*)(void))MatCholeskyFactorSymbolic_HT));
312*f5bab676SJose E. Roman   } else SETERRQ(PetscObjectComm((PetscObject)N), PETSC_ERR_SUP, "Support for factor type %s not implemented in MATTRANSPOSEVIRTUAL", MatFactorTypes[ftype]);
313*f5bab676SJose E. Roman   PetscCall(MatDestroy(&FA));
314*f5bab676SJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
315*f5bab676SJose E. Roman }
316*f5bab676SJose E. Roman 
31766976f2fSJacob Faibussowitsch static PetscErrorCode MatDestroy_HT(Mat N)
318d71ae5a4SJacob Faibussowitsch {
319bf477422SJose E. Roman   Mat A;
320d0de2241SAndrew Spott 
321d0de2241SAndrew Spott   PetscFunctionBegin;
322bf477422SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
323bf477422SJose E. Roman   PetscCall(MatDestroy(&A));
3249566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatHermitianTransposeGetMat_C", NULL));
325204606b3SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
3269566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatTransposeGetMat_C", NULL));
327204606b3SStefano Zampini #endif
328bf477422SJose E. Roman   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatProductSetFromOptions_anytype_C", NULL));
329543844c4SJose E. Roman   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatShellSetContext_C", NULL));
3303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
331d0de2241SAndrew Spott }
332d0de2241SAndrew Spott 
33366976f2fSJacob Faibussowitsch static PetscErrorCode MatDuplicate_HT(Mat N, MatDuplicateOption op, Mat *m)
334d71ae5a4SJacob Faibussowitsch {
335a1f56445SPierre Jolivet   Mat A, C;
336d0de2241SAndrew Spott 
337d0de2241SAndrew Spott   PetscFunctionBegin;
338bf477422SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
339a1f56445SPierre Jolivet   PetscCall(MatDuplicate(A, op, &C));
340a1f56445SPierre Jolivet   PetscCall(MatCreateHermitianTranspose(C, m));
341f1769f9dSJose E. Roman   if (op == MAT_COPY_VALUES) {
342f1769f9dSJose E. Roman     PetscCall(MatCopy(N, *m, SAME_NONZERO_PATTERN));
343f1769f9dSJose E. Roman     PetscCall(MatPropagateSymmetryOptions(A, C));
344f1769f9dSJose E. Roman   }
345a1f56445SPierre Jolivet   PetscCall(MatDestroy(&C));
3463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
347d0de2241SAndrew Spott }
348d0de2241SAndrew Spott 
3492543984dSJose E. Roman static PetscErrorCode MatHasOperation_HT(Mat mat, MatOperation op, PetscBool *has)
3502543984dSJose E. Roman {
3512543984dSJose E. Roman   Mat A;
3522543984dSJose E. Roman 
3532543984dSJose E. Roman   PetscFunctionBegin;
3542543984dSJose E. Roman   PetscCall(MatShellGetContext(mat, &A));
3552543984dSJose E. Roman   *has = PETSC_FALSE;
3562543984dSJose E. Roman   if (op == MATOP_MULT || op == MATOP_MULT_ADD) {
3572543984dSJose E. Roman     PetscCall(MatHasOperation(A, MATOP_MULT_HERMITIAN_TRANSPOSE, has));
3582543984dSJose E. Roman     if (!*has) PetscCall(MatHasOperation(A, MATOP_MULT_TRANSPOSE, has));
3592543984dSJose E. Roman   } else if (op == MATOP_MULT_HERMITIAN_TRANSPOSE || op == MATOP_MULT_HERMITIAN_TRANS_ADD || op == MATOP_MULT_TRANSPOSE || op == MATOP_MULT_TRANSPOSE_ADD) {
3602543984dSJose E. Roman     PetscCall(MatHasOperation(A, MATOP_MULT, has));
3612543984dSJose E. Roman   } else if (((void **)mat->ops)[op]) *has = PETSC_TRUE;
3622543984dSJose E. Roman   PetscFunctionReturn(PETSC_SUCCESS);
3632543984dSJose E. Roman }
3642543984dSJose E. Roman 
36566976f2fSJacob Faibussowitsch static PetscErrorCode MatHermitianTransposeGetMat_HT(Mat N, Mat *M)
366d71ae5a4SJacob Faibussowitsch {
36706511a5cSPierre Jolivet   PetscFunctionBegin;
368bf477422SJose E. Roman   PetscCall(MatShellGetContext(N, M));
3693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
37006511a5cSPierre Jolivet }
37106511a5cSPierre Jolivet 
37206511a5cSPierre Jolivet /*@
373013e2dc7SBarry Smith   MatHermitianTransposeGetMat - Gets the `Mat` object stored inside a `MATHERMITIANTRANSPOSEVIRTUAL`
37406511a5cSPierre Jolivet 
37520f4b53cSBarry Smith   Logically Collective
37606511a5cSPierre Jolivet 
37706511a5cSPierre Jolivet   Input Parameter:
378013e2dc7SBarry Smith . A - the `MATHERMITIANTRANSPOSEVIRTUAL` matrix
37906511a5cSPierre Jolivet 
38006511a5cSPierre Jolivet   Output Parameter:
38106511a5cSPierre Jolivet . M - the matrix object stored inside A
38206511a5cSPierre Jolivet 
38306511a5cSPierre Jolivet   Level: intermediate
38406511a5cSPierre Jolivet 
3851cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MATHERMITIANTRANSPOSEVIRTUAL`, `MatCreateHermitianTranspose()`
38606511a5cSPierre Jolivet @*/
387d71ae5a4SJacob Faibussowitsch PetscErrorCode MatHermitianTransposeGetMat(Mat A, Mat *M)
388d71ae5a4SJacob Faibussowitsch {
38906511a5cSPierre Jolivet   PetscFunctionBegin;
39006511a5cSPierre Jolivet   PetscValidHeaderSpecific(A, MAT_CLASSID, 1);
39106511a5cSPierre Jolivet   PetscValidType(A, 1);
3924f572ea9SToby Isaac   PetscAssertPointer(M, 2);
393cac4c232SBarry Smith   PetscUseMethod(A, "MatHermitianTransposeGetMat_C", (Mat, Mat *), (A, M));
3943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
39506511a5cSPierre Jolivet }
39606511a5cSPierre Jolivet 
397bf477422SJose E. Roman static PetscErrorCode MatGetDiagonal_HT(Mat N, Vec v)
398d71ae5a4SJacob Faibussowitsch {
399bf477422SJose E. Roman   Mat A;
400a0eea678SPierre Jolivet 
401a0eea678SPierre Jolivet   PetscFunctionBegin;
402bf477422SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
403bf477422SJose E. Roman   PetscCall(MatGetDiagonal(A, v));
4049566063dSJacob Faibussowitsch   PetscCall(VecConjugate(v));
4053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
406a0eea678SPierre Jolivet }
407a0eea678SPierre Jolivet 
408a1f56445SPierre Jolivet static PetscErrorCode MatCopy_HT(Mat A, Mat B, MatStructure str)
409a1f56445SPierre Jolivet {
410a1f56445SPierre Jolivet   Mat a, b;
411a1f56445SPierre Jolivet 
412a1f56445SPierre Jolivet   PetscFunctionBegin;
413a1f56445SPierre Jolivet   PetscCall(MatShellGetContext(A, &a));
414a1f56445SPierre Jolivet   PetscCall(MatShellGetContext(B, &b));
415a1f56445SPierre Jolivet   PetscCall(MatCopy(a, b, str));
416a1f56445SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
417a1f56445SPierre Jolivet }
418a1f56445SPierre Jolivet 
419bf477422SJose E. Roman static PetscErrorCode MatConvert_HT(Mat N, MatType newtype, MatReuse reuse, Mat *newmat)
420d71ae5a4SJacob Faibussowitsch {
421bf477422SJose E. Roman   Mat         A;
422b22c5e46SPierre Jolivet   PetscScalar vscale = 1.0, vshift = 0.0;
4236a4403aaSStefano Zampini   PetscBool   flg;
424a0eea678SPierre Jolivet 
425a0eea678SPierre Jolivet   PetscFunctionBegin;
426bf477422SJose E. Roman   PetscCall(MatShellGetContext(N, &A));
427bf477422SJose E. Roman   PetscCall(MatHasOperation(A, MATOP_HERMITIAN_TRANSPOSE, &flg));
428b22c5e46SPierre Jolivet   if (flg || N->ops->getrow) { /* if this condition is false, MatConvert_Shell() will be called in MatConvert_Basic(), so the following checks are not needed */
429b22c5e46SPierre Jolivet     PetscCheck(!((Mat_Shell *)N->data)->zrows && !((Mat_Shell *)N->data)->zcols, PetscObjectComm((PetscObject)N), PETSC_ERR_SUP, "Cannot call MatConvert() if MatZeroRows() or MatZeroRowsColumns() has been called on the input Mat");
430b22c5e46SPierre Jolivet     PetscCheck(!((Mat_Shell *)N->data)->axpy, PetscObjectComm((PetscObject)N), PETSC_ERR_SUP, "Cannot call MatConvert() if MatAXPY() has been called on the input Mat");
431b22c5e46SPierre Jolivet     PetscCheck(!((Mat_Shell *)N->data)->left && !((Mat_Shell *)N->data)->right, PetscObjectComm((PetscObject)N), PETSC_ERR_SUP, "Cannot call MatConvert() if MatDiagonalScale() has been called on the input Mat");
432b22c5e46SPierre Jolivet     PetscCheck(!((Mat_Shell *)N->data)->dshift, PetscObjectComm((PetscObject)N), PETSC_ERR_SUP, "Cannot call MatConvert() if MatDiagonalSet() has been called on the input Mat");
433b22c5e46SPierre Jolivet     vscale = ((Mat_Shell *)N->data)->vscale;
434b22c5e46SPierre Jolivet     vshift = ((Mat_Shell *)N->data)->vshift;
435b22c5e46SPierre Jolivet   }
4366a4403aaSStefano Zampini   if (flg) {
4376a4403aaSStefano Zampini     Mat B;
4386a4403aaSStefano Zampini 
439bf477422SJose E. Roman     PetscCall(MatHermitianTranspose(A, MAT_INITIAL_MATRIX, &B));
440ff83db7bSPierre Jolivet     if (reuse != MAT_INPLACE_MATRIX) {
4419566063dSJacob Faibussowitsch       PetscCall(MatConvert(B, newtype, reuse, newmat));
4429566063dSJacob Faibussowitsch       PetscCall(MatDestroy(&B));
443ff83db7bSPierre Jolivet     } else {
4449566063dSJacob Faibussowitsch       PetscCall(MatConvert(B, newtype, MAT_INPLACE_MATRIX, &B));
445bf477422SJose E. Roman       PetscCall(MatHeaderReplace(N, &B));
446ff83db7bSPierre Jolivet     }
4476a4403aaSStefano Zampini   } else { /* use basic converter as fallback */
448b22c5e46SPierre Jolivet     flg = (PetscBool)(N->ops->getrow != NULL);
449bf477422SJose E. Roman     PetscCall(MatConvert_Basic(N, newtype, reuse, newmat));
4506a4403aaSStefano Zampini   }
451b22c5e46SPierre Jolivet   if (flg) {
452b22c5e46SPierre Jolivet     PetscCall(MatScale(*newmat, vscale));
453b22c5e46SPierre Jolivet     PetscCall(MatShift(*newmat, vshift));
454b22c5e46SPierre Jolivet   }
4553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
456a0eea678SPierre Jolivet }
457a0eea678SPierre Jolivet 
45811a5261eSBarry Smith /*MC
459013e2dc7SBarry Smith    MATHERMITIANTRANSPOSEVIRTUAL - "hermitiantranspose" - A matrix type that represents a virtual transpose of a matrix
460d0de2241SAndrew Spott 
46111a5261eSBarry Smith   Level: advanced
46211a5261eSBarry Smith 
463a1f56445SPierre Jolivet   Developer Notes:
464543844c4SJose E. Roman   This is implemented on top of `MATSHELL` to get support for scaling and shifting without requiring duplicate code
465543844c4SJose E. Roman 
466543844c4SJose E. Roman   Users can not call `MatShellSetOperation()` operations on this class, there is some error checking for that incorrect usage
467543844c4SJose E. Roman 
4681cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MATTRANSPOSEVIRTUAL`, `Mat`, `MatCreateHermitianTranspose()`, `MatCreateTranspose()`
46911a5261eSBarry Smith M*/
47011a5261eSBarry Smith 
47111a5261eSBarry Smith /*@
472013e2dc7SBarry Smith   MatCreateHermitianTranspose - Creates a new matrix object of `MatType` `MATHERMITIANTRANSPOSEVIRTUAL` that behaves like A'*
47311a5261eSBarry Smith 
474c3339decSBarry Smith   Collective
475d0de2241SAndrew Spott 
476d0de2241SAndrew Spott   Input Parameter:
477d0de2241SAndrew Spott . A - the (possibly rectangular) matrix
478d0de2241SAndrew Spott 
479d0de2241SAndrew Spott   Output Parameter:
480d0de2241SAndrew Spott . N - the matrix that represents A'*
481d0de2241SAndrew Spott 
482d0de2241SAndrew Spott   Level: intermediate
483d0de2241SAndrew Spott 
48411a5261eSBarry Smith   Note:
48511a5261eSBarry Smith   The Hermitian transpose A' is NOT actually formed! Rather the new matrix
48611a5261eSBarry Smith   object performs the matrix-vector product, `MatMult()`, by using the `MatMultHermitianTranspose()` on
487d0de2241SAndrew Spott   the original matrix
488d0de2241SAndrew Spott 
4891cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatCreateNormal()`, `MatMult()`, `MatMultHermitianTranspose()`, `MatCreate()`,
4902ef1f0ffSBarry Smith           `MATTRANSPOSEVIRTUAL`, `MatCreateTranspose()`, `MatHermitianTransposeGetMat()`, `MATNORMAL`, `MATNORMALHERMITIAN`
491d0de2241SAndrew Spott @*/
492d71ae5a4SJacob Faibussowitsch PetscErrorCode MatCreateHermitianTranspose(Mat A, Mat *N)
493d71ae5a4SJacob Faibussowitsch {
494487d878eSStefano Zampini   VecType vtype;
495d0de2241SAndrew Spott 
496d0de2241SAndrew Spott   PetscFunctionBegin;
4979566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), N));
49887971105SStefano Zampini   PetscCall(PetscLayoutReference(A->rmap, &((*N)->cmap)));
49987971105SStefano Zampini   PetscCall(PetscLayoutReference(A->cmap, &((*N)->rmap)));
500bf477422SJose E. Roman   PetscCall(MatSetType(*N, MATSHELL));
501bf477422SJose E. Roman   PetscCall(MatShellSetContext(*N, A));
5029566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)A));
503d0de2241SAndrew Spott 
5049566063dSJacob Faibussowitsch   PetscCall(MatSetBlockSizes(*N, PetscAbs(A->cmap->bs), PetscAbs(A->rmap->bs)));
5059566063dSJacob Faibussowitsch   PetscCall(MatGetVecType(A, &vtype));
5069566063dSJacob Faibussowitsch   PetscCall(MatSetVecType(*N, vtype));
5072487f3f2SStefano Zampini #if defined(PETSC_HAVE_DEVICE)
5089566063dSJacob Faibussowitsch   PetscCall(MatBindToCPU(*N, A->boundtocpu));
5092487f3f2SStefano Zampini #endif
5109566063dSJacob Faibussowitsch   PetscCall(MatSetUp(*N));
511bf477422SJose E. Roman 
512bf477422SJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_DESTROY, (void (*)(void))MatDestroy_HT));
513bf477422SJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_MULT, (void (*)(void))MatMult_HT));
514bf477422SJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_MULT_HERMITIAN_TRANSPOSE, (void (*)(void))MatMultHermitianTranspose_HT));
515bf477422SJose E. Roman #if !defined(PETSC_USE_COMPLEX)
516bf477422SJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMultHermitianTranspose_HT));
517bf477422SJose E. Roman #endif
518f1769f9dSJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_LUFACTOR, (void (*)(void))MatLUFactor_HT));
519f1769f9dSJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_CHOLESKYFACTOR, (void (*)(void))MatCholeskyFactor_HT));
520*f5bab676SJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_GET_FACTOR, (void (*)(void))MatGetFactor_HT));
521bf477422SJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_DUPLICATE, (void (*)(void))MatDuplicate_HT));
5222543984dSJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_HAS_OPERATION, (void (*)(void))MatHasOperation_HT));
523bf477422SJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_GET_DIAGONAL, (void (*)(void))MatGetDiagonal_HT));
524a1f56445SPierre Jolivet   PetscCall(MatShellSetOperation(*N, MATOP_COPY, (void (*)(void))MatCopy_HT));
525bf477422SJose E. Roman   PetscCall(MatShellSetOperation(*N, MATOP_CONVERT, (void (*)(void))MatConvert_HT));
526bf477422SJose E. Roman 
527543844c4SJose E. Roman   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatHermitianTransposeGetMat_C", MatHermitianTransposeGetMat_HT));
528bf477422SJose E. Roman #if !defined(PETSC_USE_COMPLEX)
529543844c4SJose E. Roman   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatTransposeGetMat_C", MatHermitianTransposeGetMat_HT));
530bf477422SJose E. Roman #endif
531543844c4SJose E. Roman   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatProductSetFromOptions_anytype_C", MatProductSetFromOptions_HT));
532a1f56445SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatShellSetContext_C", MatShellSetContext_Immutable));
533a1f56445SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatShellSetContextDestroy_C", MatShellSetContextDestroy_Immutable));
534a1f56445SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatShellSetManageScalingShifts_C", MatShellSetManageScalingShifts_Immutable));
535bf477422SJose E. Roman   PetscCall(PetscObjectChangeTypeName((PetscObject)*N, MATHERMITIANTRANSPOSEVIRTUAL));
5363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
537d0de2241SAndrew Spott }
538