xref: /petsc/src/mat/impls/transpose/htransm.c (revision c4762a1b19cd2af06abeed90e8f9d34fb975dd94)
1 
2 #include <petsc/private/matimpl.h>          /*I "petscmat.h" I*/
3 
4 typedef struct {
5   Mat A;
6 } Mat_HT;
7 
8 PetscErrorCode MatMult_HT(Mat N,Vec x,Vec y)
9 {
10   Mat_HT         *Na = (Mat_HT*)N->data;
11   PetscErrorCode ierr;
12 
13   PetscFunctionBegin;
14   ierr = MatMultHermitianTranspose(Na->A,x,y);CHKERRQ(ierr);
15   PetscFunctionReturn(0);
16 }
17 
18 PetscErrorCode MatMultAdd_HT(Mat N,Vec v1,Vec v2,Vec v3)
19 {
20   Mat_HT         *Na = (Mat_HT*)N->data;
21   PetscErrorCode ierr;
22 
23   PetscFunctionBegin;
24   ierr = MatMultHermitianTransposeAdd(Na->A,v1,v2,v3);CHKERRQ(ierr);
25   PetscFunctionReturn(0);
26 }
27 
28 PetscErrorCode MatMultHermitianTranspose_HT(Mat N,Vec x,Vec y)
29 {
30   Mat_HT         *Na = (Mat_HT*)N->data;
31   PetscErrorCode ierr;
32 
33   PetscFunctionBegin;
34   ierr = MatMult(Na->A,x,y);CHKERRQ(ierr);
35   PetscFunctionReturn(0);
36 }
37 
38 PetscErrorCode MatMultHermitianTransposeAdd_HT(Mat N,Vec v1,Vec v2,Vec v3)
39 {
40   Mat_HT         *Na = (Mat_HT*)N->data;
41   PetscErrorCode ierr;
42 
43   PetscFunctionBegin;
44   ierr = MatMultAdd(Na->A,v1,v2,v3);CHKERRQ(ierr);
45   PetscFunctionReturn(0);
46 }
47 
48 PetscErrorCode MatDestroy_HT(Mat N)
49 {
50   Mat_HT         *Na = (Mat_HT*)N->data;
51   PetscErrorCode ierr;
52 
53   PetscFunctionBegin;
54   ierr = MatDestroy(&Na->A);CHKERRQ(ierr);
55   ierr = PetscFree(N->data);CHKERRQ(ierr);
56   PetscFunctionReturn(0);
57 }
58 
59 PetscErrorCode MatDuplicate_HT(Mat N, MatDuplicateOption op, Mat* m)
60 {
61   Mat_HT         *Na = (Mat_HT*)N->data;
62   PetscErrorCode ierr;
63 
64   PetscFunctionBegin;
65   if (op == MAT_COPY_VALUES) {
66     ierr = MatHermitianTranspose(Na->A,MAT_INITIAL_MATRIX,m);CHKERRQ(ierr);
67   } else if (op == MAT_DO_NOT_COPY_VALUES) {
68     ierr = MatDuplicate(Na->A,MAT_DO_NOT_COPY_VALUES,m);CHKERRQ(ierr);
69     ierr = MatHermitianTranspose(*m,MAT_INPLACE_MATRIX,m);CHKERRQ(ierr);
70   } else SETERRQ(PetscObjectComm((PetscObject)N),PETSC_ERR_SUP,"MAT_SHARE_NONZERO_PATTERN not supported for this matrix type");
71   PetscFunctionReturn(0);
72 }
73 
74 PetscErrorCode MatCreateVecs_HT(Mat N,Vec *r, Vec *l)
75 {
76   Mat_HT         *Na = (Mat_HT*)N->data;
77   PetscErrorCode ierr;
78 
79   PetscFunctionBegin;
80   ierr = MatCreateVecs(Na->A,l,r);CHKERRQ(ierr);
81   PetscFunctionReturn(0);
82 }
83 
84 PetscErrorCode MatAXPY_HT(Mat Y,PetscScalar a,Mat X,MatStructure str)
85 {
86   Mat_HT         *Ya = (Mat_HT*)Y->data;
87   Mat_HT         *Xa = (Mat_HT*)X->data;
88   Mat              M = Ya->A;
89   Mat              N = Xa->A;
90   PetscErrorCode ierr;
91 
92   PetscFunctionBegin;
93   ierr = MatAXPY(M,a,N,str);CHKERRQ(ierr);
94   PetscFunctionReturn(0);
95 }
96 
97 PetscErrorCode MatHermitianTransposeGetMat_HT(Mat N,Mat *M)
98 {
99   Mat_HT         *Na = (Mat_HT*)N->data;
100 
101   PetscFunctionBegin;
102   *M = Na->A;
103   PetscFunctionReturn(0);
104 }
105 
106 /*@
107       MatHermitianTransposeGetMat - Gets the Mat object stored inside a MATTRANSPOSEMAT
108 
109    Logically collective on Mat
110 
111    Input Parameter:
112 .   A  - the MATTRANSPOSE matrix
113 
114    Output Parameter:
115 .   M - the matrix object stored inside A
116 
117    Level: intermediate
118 
119 .seealso: MatCreateHermitianTranspose()
120 
121 @*/
122 PetscErrorCode MatHermitianTransposeGetMat(Mat A,Mat *M)
123 {
124   PetscErrorCode ierr;
125 
126   PetscFunctionBegin;
127   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
128   PetscValidType(A,1);
129   PetscValidPointer(M,2);
130   ierr = PetscUseMethod(A,"MatHermitianTransposeGetMat_C",(Mat,Mat*),(A,M));CHKERRQ(ierr);
131   PetscFunctionReturn(0);
132 }
133 
134 /*@
135       MatCreateHermitianTranspose - Creates a new matrix object that behaves like A'*
136 
137    Collective on Mat
138 
139    Input Parameter:
140 .   A  - the (possibly rectangular) matrix
141 
142    Output Parameter:
143 .   N - the matrix that represents A'*
144 
145    Level: intermediate
146 
147    Notes:
148     The hermitian transpose A' is NOT actually formed! Rather the new matrix
149           object performs the matrix-vector product by using the MatMultHermitianTranspose() on
150           the original matrix
151 
152 .seealso: MatCreateNormal(), MatMult(), MatMultHermitianTranspose(), MatCreate()
153 
154 @*/
155 PetscErrorCode  MatCreateHermitianTranspose(Mat A,Mat *N)
156 {
157   PetscErrorCode ierr;
158   PetscInt       m,n;
159   Mat_HT         *Na;
160 
161   PetscFunctionBegin;
162   ierr = MatGetLocalSize(A,&m,&n);CHKERRQ(ierr);
163   ierr = MatCreate(PetscObjectComm((PetscObject)A),N);CHKERRQ(ierr);
164   ierr = MatSetSizes(*N,n,m,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
165   ierr = PetscLayoutSetUp((*N)->rmap);CHKERRQ(ierr);
166   ierr = PetscLayoutSetUp((*N)->cmap);CHKERRQ(ierr);
167   ierr = PetscObjectChangeTypeName((PetscObject)*N,MATTRANSPOSEMAT);CHKERRQ(ierr);
168 
169   ierr       = PetscNewLog(*N,&Na);CHKERRQ(ierr);
170   (*N)->data = (void*) Na;
171   ierr       = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
172   Na->A      = A;
173 
174   (*N)->ops->destroy                    = MatDestroy_HT;
175   (*N)->ops->mult                       = MatMult_HT;
176   (*N)->ops->multadd                    = MatMultAdd_HT;
177   (*N)->ops->multhermitiantranspose     = MatMultHermitianTranspose_HT;
178   (*N)->ops->multhermitiantransposeadd  = MatMultHermitianTransposeAdd_HT;
179   (*N)->ops->duplicate                  = MatDuplicate_HT;
180   (*N)->ops->getvecs                    = MatCreateVecs_HT;
181   (*N)->ops->axpy                       = MatAXPY_HT;
182   (*N)->assembled                       = PETSC_TRUE;
183 
184   ierr = PetscObjectComposeFunction((PetscObject)(*N),"MatHermitianTransposeGetMat_C",MatHermitianTransposeGetMat_HT);CHKERRQ(ierr);
185   ierr = MatSetBlockSizes(*N,PetscAbs(A->cmap->bs),PetscAbs(A->rmap->bs));CHKERRQ(ierr);
186   ierr = MatSetUp(*N);CHKERRQ(ierr);
187   PetscFunctionReturn(0);
188 }
189